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. De API biedt app-specifieke synchroniseerbare opslag voor offline gebruik en caching, zodat dezelfde gegevens beschikbaar zijn voor verschillende clients. Lees Gegevens beheren voor meer informatie over het gebruik van deze API.

Rechten

syncFileSystem

Typen

ConflictResolutionPolicy

Enum

"last_write_win"

"manual"

FileInfo

Eigenschappen

  • actie

    SyncAction optioneel

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

  • routebeschrijving

    SyncDirection optioneel

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

  • fileEntry

    Toegang

    fileEntry voor het doelbestand waarvan de status is gewijzigd. Bevat de naam en het pad van het gesynchroniseerde bestand. Als je het bestand verwijdert, is de informatie van fileEntry nog steeds beschikbaar, maar bestaat het bestand niet meer.

  • status

    FileStatus

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

FileStatus

Enum

synced
Niet conflicterend en heeft geen lokale wijzigingen in de wachtrij.

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

"conflicting"
Het 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 betreffende bestand.

  • fileEntry

    Toegang

    Een van de invoeren die oorspronkelijk aan getFileStatuses is gegeven.

  • status

    FileStatus

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

ServiceInfo

Eigenschappen

ServiceStatus

Enum

"initializing"
De synchronisatieservice wordt geïnitialiseerd (bijvoorbeeld gegevens herstellen uit de database, de connectiviteit controleren en verifiëren bij de service).

running
De synchronisatieservice is actief.

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

"temporary_unavailable"
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, enzovoort. Meer informatie wordt gegeven door de parameter description in OnServiceInfoUpdated (die servicespecifieke informatie kan bevatten).

"disabled"
De synchronisatieservice staat uit en de content wordt nooit gesynchroniseerd. (Dit kan bijvoorbeeld gebeuren als de gebruiker geen account heeft voor de externe service of als de synchronisatieservice een onherstelbare fout heeft opgelopen.)

StorageInfo

Eigenschappen

  • quotaBytes

    getal

  • usageBytes

    getal

SyncAction

Enum

"added"

"updated"

"deleted"

SyncDirection

Enum

"local_to_remote"

"remote_to_local"

Methoden

getConflictResolutionPolicy()

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

Haalt het huidige beleid voor conflictoplossing op.

Parameters

Retourzendingen

  • Chrome 117+

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

getFileStatus()

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

Retourneert de FileStatus voor de opgegeven fileEntry. De statuswaarde kan 'synced', 'pending' of 'conflicting' zijn. De status 'conflicting' treedt alleen op als het beleid voor conflictoplossing van de service is ingesteld op 'manual'.

Parameters

  • fileEntry

    Toegang

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (status: FileStatus) => void

Retourzendingen

  • Promise<FileStatus>

    Chrome 117+

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

getFileStatuses()

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

Retourneert elke FileStatus voor de opgegeven fileEntry-matrix. Wordt meestal aangeroepen met het resultaat van dirReader.readEntries().

Parameters

  • fileEntries

    object[]

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (status: FileStatusInfo[]) => void

Retourzendingen

  • Belofte<FileStatusInfo[]>

    Chrome 117+

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

getServiceStatus()

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

Retourneert de huidige status van de synchronisatiebackend.

Parameters

Retourzendingen

  • Promise<ServiceStatus>

    Chrome 117+

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

getUsageAndQuota()

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

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

Parameters

  • fileSystem

    DOMFileSystem

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (info: StorageInfo) => void

Retourzendingen

  • Promise<StorageInfo>

    Chrome 117+

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

requestFileSystem()

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

Retourneert een synchroniseerbaar bestandssysteem dat wordt ondersteund door Google Drive. 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 je deze methode meerdere keren aanroept vanuit dezelfde app, wordt dezelfde handle naar hetzelfde bestandssysteem geretourneerd.

Deze aanroep kan mislukken. Bijvoorbeeld als de gebruiker niet is ingelogd bij Chrome of als er geen netwerkbewerking is. Het is belangrijk dat chrome.runtime.lastError wordt gecontroleerd in de callback om deze fouten af te handelen.

Parameters

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

Retourzendingen

  • Promise<DOMFileSystem>

    Chrome 117+

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

setConflictResolutionPolicy()

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

Hiermee stel je het standaardbeleid voor conflictoplossing in voor de 'syncable'-bestandsopslag voor de app. Dit is standaard ingesteld op 'last_write_win'. Als het beleid voor conflictoplossing is ingesteld op 'last_write_win', worden conflicten voor bestaande bestanden automatisch opgelost de volgende keer dat het bestand wordt geüpdatet. callback kan optioneel worden gegeven om te weten of het verzoek is geslaagd of niet.

Parameters

Retourzendingen

  • Promise<void>

    Chrome 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 als een bestand is geüpdatet door de achtergrondsynchronisatieservice.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (detail: FileInfo) => void

onServiceStatusChanged

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

Wordt geactiveerd als er een fout of andere statuswijziging is opgetreden in de synchronisatiebackend (bijvoorbeeld als de synchronisatie tijdelijk is uitgezet vanwege een netwerk- of verificatiefout).

Parameters