chrome.syncFileSystem

Beschrijving

Gebruik de chrome.syncFileSystem API om gegevens op te slaan en te synchroniseren in Google Drive. Deze API is NIET bedoeld voor toegang tot willekeurige gebruikersdocumenten die zijn opgeslagen in Google Drive. Het biedt app-specifieke synchroniseerbare opslag voor offline- en cachegebruik, zodat dezelfde gegevens beschikbaar zijn op verschillende clients. Lees Gegevens beheren voor meer informatie over het gebruik van deze API.

Machtigingen

syncFileSystem

Typen

ConflictResolutionPolicy

Enum

"laatste_schrijf_win"

"handmatig"

FileInfo

Eigenschappen

  • actie

    SyncAction optioneel

    Synchronisatieactie die is uitgevoerd om de gebeurtenis onFileStatusChanged te activeren. De actiewaarde kan 'added' , 'updated' of 'deleted' zijn. Alleen van toepassing als de status 'synced' is.

  • richting

    SyncDirection optioneel

    Synchronisatierichting voor de gebeurtenis onFileStatusChanged . De synchronisatierichting kan 'local_to_remote' of 'remote_to_local' zijn. Alleen van toepassing als de status 'synced' is.

  • bestandsinvoer

    Toegang

    fileEntry voor het doelbestand waarvan de status is gewijzigd. Bevat naam- en padinformatie van het gesynchroniseerde bestand. Bij het verwijderen van het bestand blijft fileEntry informatie beschikbaar, maar bestaat het bestand niet meer.

  • Resulterende bestandsstatus na onFileStatusChanged -gebeurtenis. De statuswaarde kan 'synced' , 'pending' of 'conflicting' zijn.

FileStatus

Enum

"gesynchroniseerd"
Er is geen sprake van conflict en er zijn geen lokale wijzigingen in behandeling.

"in behandeling"
Er zijn een of meer lokale wijzigingen in behandeling die nog niet zijn gesynchroniseerd.

"conflicterend"
Bestandsconflicten met de externe versie moeten handmatig worden opgelost.

FileStatusInfo

Eigenschappen

  • fout

    string optioneel

    Optionele fout die alleen wordt geretourneerd als er een probleem is opgetreden bij het ophalen van de FileStatus voor het opgegeven bestand.

  • bestandsinvoer

    Toegang

    Een van de invoergegevens die oorspronkelijk aan getFileStatuses werd gegeven.

  • De statuswaarde kan 'synced' , 'pending' of 'conflicting' zijn.

ServiceInfo

Eigenschappen

ServiceStatus

Enum

"initialiseren"
De synchronisatieservice wordt geïnitialiseerd (bijvoorbeeld door gegevens uit de database te herstellen, de connectiviteit te controleren en te authenticeren bij de service, enz.).

"rennen"
De synchronisatieservice is operationeel.

"authenticatie_vereist"
De synchronisatieservice synchroniseert de bestanden niet omdat de gebruiker de externe service moet verifiëren om door te kunnen gaan.

"tijdelijk_niet beschikbaar"
De synchronisatieservice synchroniseert geen bestanden omdat de externe service (tijdelijk) niet beschikbaar is vanwege herstelbare fouten, bijvoorbeeld omdat het netwerk offline is, de externe service niet beschikbaar of niet bereikbaar is, etc. Meer details moeten worden gegeven via description in OnServiceInfoUpdated (die servicespecifieke details kan bevatten).

"gehandicapt"
De synchronisatieservice is uitgeschakeld en de inhoud wordt nooit gesynchroniseerd. (Dit kan bijvoorbeeld gebeuren als de gebruiker geen account heeft op de externe service of als er een onherstelbare fout in de synchronisatieservice is opgetreden.)

StorageInfo

Eigenschappen

  • quotumBytes

    nummer

  • gebruikBytes

    nummer

SyncAction

Enum

"toegevoegd"

"bijgewerkt"

"verwijderd"

SyncDirection

Enum

"lokaal_naar_op_afstand"

"op_afstand_naar_lokaal"

Methoden

getConflictResolutionPolicy()

Belofte
chrome.syncFileSystem.getConflictResolutionPolicy(
  callback?: function,
): Promise<ConflictResolutionPolicy>

Haalt het huidige beleid voor conflictbemiddeling op.

Parameters

Retourneren

  • Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getFileStatus()

Belofte
chrome.syncFileSystem.getFileStatus(
  fileEntry: Entry,
  callback?: function,
): Promise<FileStatus>

Retourneert de FileStatus voor de opgegeven fileEntry . De statuswaarde kan 'synced' , 'pending' of 'conflicting' zijn. Let op: de status 'conflicting' treedt alleen op wanneer het conflictoplossingsbeleid van de service is ingesteld op 'manual' .

Parameters

  • bestandsinvoer

    Toegang

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (status: FileStatus) => void

Retourneren

  • Belofte< FileStatus >

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getFileStatuses()

Belofte
chrome.syncFileSystem.getFileStatuses(
  fileEntries: object[],
  callback?: function,
): Promise<FileStatusInfo[]>

Retourneert elke FileStatus voor de gegeven fileEntry array. Wordt meestal aangeroepen met het resultaat van dirReader.readEntries().

Parameters

  • bestandsvermeldingen

    voorwerp[]

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (status: FileStatusInfo[]) => void

Retourneren

  • Belofte< FileStatusInfo []>

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getServiceStatus()

Belofte
chrome.syncFileSystem.getServiceStatus(
  callback?: function,
): Promise<ServiceStatus>

Geeft de huidige synchronisatie-backendstatus terug.

Parameters

Retourneren

  • Belofte< ServiceStatus >

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getUsageAndQuota()

Belofte
chrome.syncFileSystem.getUsageAndQuota(
  fileSystem: DOMFileSystem,
  callback?: function,
): Promise<StorageInfo>

Geeft het huidige gebruik en quotum in bytes terug voor de 'syncable' bestandsopslag voor de app.

Parameters

  • bestandssysteem

    DOMFileSystem

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (info: StorageInfo) => void

Retourneren

  • Promise< StorageInfo >

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

requestFileSystem()

Belofte
chrome.syncFileSystem.requestFileSystem(
  callback?: function,
): Promise<DOMFileSystem>

Retourneert een synchroniseerbaar bestandssysteem met Google Drive-ondersteuning. De geretourneerde DOMFileSystem instantie kan op dezelfde manier worden gebruikt als de tijdelijke en permanente bestandssystemen (zie http://dev.w3.org/2009/dap/file-system/file-dir-sys.html ).

Als u dit meerdere keren vanuit dezelfde app aanroept, wordt dezelfde handle naar hetzelfde bestandssysteem geretourneerd.

Let op: deze aanroep kan mislukken. Bijvoorbeeld als de gebruiker niet is aangemeld bij Chrome of als er geen netwerkverbinding is. Om deze fouten te kunnen verwerken, is het belangrijk dat chrome.runtime.lastError wordt gecontroleerd in de callback.

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (fileSystem: DOMFileSystem) => void

    • bestandssysteem

      DOMFileSystem

Retourneren

  • Belofte<DOMFileSystem>

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setConflictResolutionPolicy()

Belofte
chrome.syncFileSystem.setConflictResolutionPolicy(
  policy: ConflictResolutionPolicy,
  callback?: function,
): Promise<void>

Stelt het standaardbeleid voor conflictoplossing in voor de 'syncable' bestandsopslag voor de app. Standaard is dit ingesteld op 'last_write_win' . Wanneer het conflictoplossingsbeleid is ingesteld op 'last_write_win' , worden conflicten voor bestaande bestanden automatisch opgelost wanneer het bestand de volgende keer wordt bijgewerkt. Optioneel kan callback worden opgegeven om te laten weten of de aanvraag is geslaagd of niet.

Parameters

Retourneren

  • Belofte<leegte>

    Chroom 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Evenementen

onFileStatusChanged

chrome.syncFileSystem.onFileStatusChanged.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een bestand is bijgewerkt door de achtergrondsynchronisatieservice.

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (detail: FileInfo) => void

onServiceStatusChanged

chrome.syncFileSystem.onServiceStatusChanged.addListener(
  callback: function,
)

Wordt geactiveerd wanneer er een fout of andere statuswijziging heeft plaatsgevonden in de synchronisatie-backend (bijvoorbeeld wanneer de synchronisatie tijdelijk is uitgeschakeld vanwege een netwerk- of authenticatiefout).

Parameters