chrome.syncFileSystem

Beschreibung

Mit der chrome.syncFileSystem API können Sie Daten in Google Drive speichern und synchronisieren. Diese API ist NICHT für den Zugriff auf beliebige Nutzerdokumente gedacht, die in Google Drive gespeichert sind. Es bietet einen anwendungsspezifischen synchronisierbaren Speicher für Offline- und Caching-Nutzung, sodass dieselben Daten auf verschiedenen Clients verfügbar sind. Weitere Informationen zur Verwendung dieser API finden Sie unter Daten verwalten.

Berechtigungen

syncFileSystem

Typen

ConflictResolutionPolicy

Enum

"last_write_win"

"manuell"

FileInfo

Attribute

  • Aktion

    SyncAction – optional

    Synchronisierungsaktion, die zum Auslösen des Ereignisses onFileStatusChanged durchgeführt wurde. Der Aktionswert kann 'added', 'updated' oder 'deleted' sein. Gilt nur, wenn der Status 'synced' ist.

  • direction

    SyncDirection optional

    Synchronisierungsrichtung für den Termin onFileStatusChanged. Der Wert für die Synchronisierungsrichtung kann 'local_to_remote' oder 'remote_to_local' sein. Gilt nur, wenn der Status 'synced' ist.

  • fileEntry

    Eintrag

    fileEntry für die Zieldatei, deren Status sich geändert hat. Enthält die Namen und Pfadinformationen der synchronisierten Datei. Wenn eine Datei gelöscht wird, sind Informationen zu fileEntry weiterhin verfügbar, die Datei ist jedoch nicht mehr vorhanden.

  • Status

    FileStatus

    Resultierender Dateistatus nach dem Ereignis onFileStatusChanged. Der Statuswert kann 'synced', 'pending' oder 'conflicting' sein.

FileStatus

Enum

"synced"
Nicht widersprüchlich und hat keine ausstehenden lokalen Änderungen.

"pending"
Hat mindestens eine ausstehende lokale Änderung, die noch nicht synchronisiert wurde.

"Konflikt"
Die Datei steht in Konflikt mit der Remote-Version und muss manuell gelöst werden.

FileStatusInfo

Attribute

  • Fehler

    String optional

    Optionaler Fehler, der nur zurückgegeben wird, wenn beim Abrufen des FileStatus für die angegebene Datei ein Problem aufgetreten ist.

  • fileEntry

    Eintrag

    Einer der ursprünglich für getFileStatuses angegebenen Einträge.

  • Status

    FileStatus

    Der Statuswert kann 'synced', 'pending' oder 'conflicting' sein.

ServiceInfo

Attribute

ServiceStatus

Enum

"initializing"
Der Synchronisierungsdienst wird initialisiert (z. B. Wiederherstellung von Daten aus der Datenbank, Prüfen der Verbindung, Authentifizierung beim Dienst usw.).

"wird ausgeführt"
Der Synchronisierungsdienst ist einsatzbereit.

"authentication_required"
Der Synchronisierungsdienst synchronisiert keine Dateien, da der Remote-Dienst vom Nutzer authentifiziert werden muss, um fortzufahren.

"tempo_unavailable"
Der Synchronisierungsdienst synchronisiert keine Dateien, da der Remote-Dienst aufgrund von behebbaren Fehlern (z.B. Netzwerk ist offline, der Remote-Dienst ist ausgefallen oder nicht erreichbar. Weitere Details sollten über den Parameter description in OnServiceInfoUpdated angegeben werden. Dieser kann dienstspezifische Details enthalten.

"deaktiviert"
Der Synchronisierungsdienst ist deaktiviert und die Inhalte werden nie synchronisiert. Dies kann beispielsweise der Fall sein, wenn der Nutzer kein Konto für den Remote-Dienst hat oder beim Synchronisierungsdienst ein nicht behebbarer Fehler aufgetreten ist.

StorageInfo

Attribute

  • quotaBytes

    Zahl

  • usageBytes

    Zahl

SyncAction

Enum

"hinzugefügt"

"aktualisiert"

"gelöscht"

SyncDirection

Enum

"local_to_remote"

"remote_to_local"

Methoden

getConflictResolutionPolicy()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.syncFileSystem.getConflictResolutionPolicy(
  callback?: function,
)

Ruft die aktuelle Konfliktlösungsrichtlinie ab.

Parameter

Gibt Folgendes zurück:

  • Promise&lt;ConflictResolutionPolicy&gt;

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getFileStatus()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.syncFileSystem.getFileStatus(
  fileEntry: Entry,
  callback?: function,
)

Gibt das FileStatus für die angegebene fileEntry zurück. Der Statuswert kann 'synced', 'pending' oder 'conflicting' sein. Der 'conflicting'-Status tritt nur auf, wenn die Konfliktlösungsrichtlinie des Dienstes auf 'manual' gesetzt ist.

Parameter

  • fileEntry

    Eintrag

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (status: FileStatus) => void

Gibt Folgendes zurück:

  • Promise&lt;FileStatus&gt;

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getFileStatuses()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.syncFileSystem.getFileStatuses(
  fileEntries: object[],
  callback?: function,
)

Gibt alle FileStatus für das angegebene fileEntry-Array zurück. Wird normalerweise mit dem Ergebnis von dirReader.readEntries() aufgerufen.

Parameter

  • fileEntries

    object[]

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (status: FileStatusInfo[]) => void

Gibt Folgendes zurück:

  • Promise&lt;FileStatusInfo[]&gt;

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getServiceStatus()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.syncFileSystem.getServiceStatus(
  callback?: function,
)

Gibt den aktuellen Status des Back-End für die Synchronisierung zurück.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (status: ServiceStatus) => void

Gibt Folgendes zurück:

  • Promise&lt;ServiceStatus&gt;

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getUsageAndQuota()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.syncFileSystem.getUsageAndQuota(
  fileSystem: DOMFileSystem,
  callback?: function,
)

Gibt die aktuelle Nutzung und das Kontingent für den Dateispeicher 'syncable' der Anwendung in Byte zurück.

Parameter

  • fileSystem

    DOMFileSystem

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (info: StorageInfo) => void

Gibt Folgendes zurück:

  • Promise&lt;StorageInfo&gt;

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

requestFileSystem()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.syncFileSystem.requestFileSystem(
  callback?: function,
)

Gibt ein synchronisierbares Dateisystem zurück, das von Google Drive unterstützt wird. Die zurückgegebene DOMFileSystem-Instanz kann auf die gleiche Weise wie die temporären und persistenten Dateisysteme betrieben werden (siehe http://dev.w3.org/2009/dap/file-system/file-dir-sys.html).

Wenn Sie diese Methode mehrmals aus derselben App aufrufen, wird derselbe Alias an dasselbe Dateisystem zurückgegeben.

Beachten Sie, dass dieser Aufruf fehlschlagen kann. Das ist beispielsweise der Fall, wenn der Nutzer nicht in Chrome angemeldet ist oder keine Netzwerkverbindung besteht. Zum Beheben dieser Fehler ist es wichtig, dass „chrome.runtime.lastError“ im Callback geprüft wird.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

Gibt Folgendes zurück:

  • Promise&lt;DOMFileSystem&gt;

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setConflictResolutionPolicy()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.syncFileSystem.setConflictResolutionPolicy(
  policy: ConflictResolutionPolicy,
  callback?: function,
)

Legt die Standardrichtlinie zur Konfliktlösung für den 'syncable'-Dateispeicher der App fest. Standardmäßig ist 'last_write_win' festgelegt. Wenn die Richtlinie zur Konfliktlösung auf „'last_write_win'“ gesetzt ist, werden Konflikte für vorhandene Dateien bei der nächsten Aktualisierung der Datei automatisch gelöst. callback kann optional angegeben werden, um zu erfahren, ob die Anfrage erfolgreich war oder nicht.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome 117 oder höher

    Promise-Objekte werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

Ereignisse

onFileStatusChanged

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

Wird ausgelöst, wenn eine Datei vom Dienst für die Hintergrundsynchronisierung aktualisiert wurde.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (detail: FileInfo) => void

onServiceStatusChanged

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

Wird ausgelöst, wenn ein Fehler oder eine andere Statusänderung im Synchronisierungs-Backend aufgetreten ist, z. B. wenn die Synchronisierung aufgrund eines Netzwerk- oder Authentifizierungsfehlers vorübergehend deaktiviert wurde

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (detail: ServiceInfo) => void