chrome.syncFileSystem

Beschrijving

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

Machtigingen

syncFileSystem

Soorten

ConflictResolutionPolicy

Enum

"laatste_schrijf_win"

"handmatig"

FileInfo

Eigenschappen

  • actie

    SyncAction optioneel

    Synchronisatieactie ondernomen om onFileStatusChanged -gebeurtenis te activeren. De actiewaarde kan 'added' , 'updated' of 'deleted' zijn. Geldt alleen als de status 'synced' is.

  • richting

    SyncDirection optioneel

    Synchronisatierichting voor de onFileStatusChanged -gebeurtenis. De waarde voor de synchronisatierichting kan 'local_to_remote' of 'remote_to_local' zijn. Geldt alleen als de status 'synced' is.

  • bestandsinvoer

    Binnenkomst

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

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

FileStatus

Enum

"gesynchroniseerd"
Niet conflicterend en er zijn geen lokale wijzigingen in behandeling.

"in behandeling"
Bevat een of meer lokale wijzigingen die in behandeling zijn en die niet zijn gesynchroniseerd.

"conflicterend"
Bestand conflicteert met de externe versie en moet handmatig worden opgelost.

FileStatusInfo

Eigenschappen

  • fout

    tekenreeks optioneel

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

  • bestandsinvoer

    Binnenkomst

    Een van de vermeldingen die oorspronkelijk is gegeven aan getFileStatuses.

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

ServiceInfo

Eigenschappen

ServiceStatus

Enum

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

"rennen"
De synchronisatieservice is actief.

"authenticatie_vereist"
De synchronisatieservice synchroniseert geen bestanden omdat de externe service door de gebruiker moet worden geverifieerd om door te gaan.

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

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

StorageInfo

Eigenschappen

  • quotaBytes

    nummer

  • gebruikBytes

    nummer

SyncAction

Enum

"toegevoegd"

"bijgewerkt"

"verwijderd"

SyncDirection

Enum

"lokaal_naar_remote"

"op afstand_naar_lokaal"

Methoden

getConflictResolutionPolicy()

Belofte
chrome.syncFileSystem.getConflictResolutionPolicy(
  callback?: function,
)

Haalt het huidige beleid voor conflictoplossing op.

Parameters

Retouren

  • Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getFileStatus()

Belofte
chrome.syncFileSystem.getFileStatus(
  fileEntry: Entry,
  callback?: function,
)

Retourneert de FileStatus voor de opgegeven fileEntry . De statuswaarde kan 'synced' , 'pending' of 'conflicting' zijn. Houd er rekening mee dat 'conflicting' status alleen optreedt als het conflictoplossingsbeleid van de service is ingesteld op 'manual' .

Parameters

  • bestandsinvoer

    Binnenkomst

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (status: FileStatus) => void

Retouren

  • Beloof < Bestandsstatus >

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getFileStatuses()

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

Retourneert elke FileStatus voor de opgegeven fileEntry array. Meestal aangeroepen met het resultaat van dirReader.readEntries().

Parameters

  • bestandsinvoer

    voorwerp[]

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (status: FileStatusInfo[]) => void

Retouren

  • Beloof < FileStatusInfo []>

    Chroom 117+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getServiceStatus()

Belofte
chrome.syncFileSystem.getServiceStatus(
  callback?: function,
)

Retourneert de huidige status van de synchronisatie-backend.

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (status: ServiceStatus) => void

Retouren

  • Beloof < ServiceStatus >

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getUsageAndQuota()

Belofte
chrome.syncFileSystem.getUsageAndQuota(
  fileSystem: DOMFileSystem,
  callback?: function,
)

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

Parameters

  • bestandssysteem

    DOMFilesysteem

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (info: StorageInfo) => void

Retouren

  • Beloof < StorageInfo >

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

requestFileSystem()

Belofte
chrome.syncFileSystem.requestFileSystem(
  callback?: function,
)

Retourneert een synchroniseerbaar bestandssysteem ondersteund door Google Drive. De geretourneerde DOMFileSystem instantie kan op dezelfde manier worden gebruikt als de tijdelijke en persistente 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.

Houd er rekening mee dat deze oproep kan mislukken. Bijvoorbeeld als de gebruiker niet is aangemeld bij Chrome of als er geen netwerkbewerking plaatsvindt. Om deze fouten af ​​te handelen is het belangrijk dat chrome.runtime.lastError wordt aangevinkt in de callback.

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (fileSystem: DOMFileSystem) => void

    • bestandssysteem

      DOMFilesysteem

Retouren

  • Beloof<DOMFileSystem>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

setConflictResolutionPolicy()

Belofte
chrome.syncFileSystem.setConflictResolutionPolicy(
  policy: ConflictResolutionPolicy,
  callback?: function,
)

Stelt het standaardbeleid voor conflictoplossing in voor de 'syncable' bestandsopslag voor de app. Standaard is dit ingesteld op 'last_write_win' . Wanneer het beleid voor conflictoplossing is ingesteld op 'last_write_win' worden conflicten voor bestaande bestanden automatisch opgelost de volgende keer dat het bestand wordt bijgewerkt. callback kan optioneel worden gegeven om te weten of het verzoek is geslaagd of niet.

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 117+

    Beloften 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 parameter 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

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (detail: ServiceInfo) => void