chrome.syncFileSystem

Opis

Aby zapisywać i synchronizować dane na Dysku Google, użyj interfejsu API chrome.syncFileSystem. Ten interfejs API NIE służy do uzyskiwania dostępu do dowolnych dokumentów użytkownika przechowywanych na Dysku Google. Zapewnia pamięć przeznaczoną do synchronizacji w ramach aplikacji na potrzeby korzystania z funkcji offline i pamięci podręcznej, dzięki czemu te same dane są dostępne w różnych klientach. Więcej informacji o korzystaniu z tego interfejsu API znajdziesz w artykule Zarządzanie danymi.

Uprawnienia

syncFileSystem

Typy

ConflictResolutionPolicy

Typ wyliczeniowy

"last_write_win"

„manual”

FileInfo

Właściwości

  • działanie

    SyncAction opcjonalny

    Działanie synchronizacji podjęte w celu wywołania zdarzenia onFileStatusChanged. Wartość działania może być 'added', 'updated' lub 'deleted'. Ma zastosowanie tylko wtedy, gdy stan to 'synced'.

  • direction

    SyncDirection opcjonalnie

    Kierunek synchronizacji dla zdarzenia onFileStatusChanged. Wartość kierunku synchronizacji może być 'local_to_remote' lub 'remote_to_local'. Ma zastosowanie tylko wtedy, gdy stan to 'synced'.

  • fileEntry

    Wpis

    fileEntry dla docelowego pliku, którego stan się zmienił. Zawiera nazwę i ścieżkę do zsynchronizowanego pliku. Po usunięciu pliku informacje fileEntry będą nadal dostępne, ale sam plik przestanie istnieć.

  • status

    FileStatus

    Stan pliku po zdarzeniu onFileStatusChanged. Wartość stanu może być 'synced', 'pending' lub 'conflicting'.

FileStatus

Typ wyliczeniowy

„zsynchronizowany”
Brak konfliktów i zawieszonych zmian lokalnych.

„oczekujące”
Obejmuje co najmniej jedną lokalną zmianę, która nie została zsynchronizowana.

„conflicting” (konfliktujący)
Plik jest w konflikcie z wersją zdaną i musi zostać rozwiązany ręcznie.

FileStatusInfo

Właściwości

  • błąd

    ciąg znaków opcjonalny

    Opcjonalny błąd zwracany tylko wtedy, gdy wystąpił problem z pobraniem stanu pliku.

  • fileEntry

    Wpis

    Jeden z elementów wejściowych przekazanych pierwotnie do getFileStatuses.

  • status

    FileStatus

    Wartość stanu może być 'synced', 'pending' lub 'conflicting'.

ServiceInfo

Właściwości

ServiceStatus

Typ wyliczeniowy

„inicjalizacja”
Usługa synchronizacji jest inicjowana (np. przywracanie danych z bazy danych, sprawdzanie łączności i uwierzytelnianie w usłudze).

„running” (działający)
Usługa synchronizacji działa.

"authentication_required"
Usługa synchronizacji nie synchronizuje plików, ponieważ usługa zdalna musi zostać uwierzytelniona przez użytkownika.

"temporary_unavailable"
Usługa synchronizacji nie synchronizuje plików, ponieważ usługa zdalna jest (tymczasowo) niedostępna z powodu niektórych odwracalnych błędów, np. sieć jest offline, usługa zdalna jest niedostępna lub nie można się z nią połączyć. Więcej informacji można znaleźć w parametrze description w funkcji OnServiceInfoUpdated (może on zawierać informacje o konkretnej usłudze).

„disabled” (wyłączona)
Usługa synchronizacji jest wyłączona i nigdy nie będzie synchronizować treści. (Może się tak zdarzyć, gdy użytkownik nie ma konta w usłudze zdalnej lub gdy usługa synchronizacji napotkała nieodwracalny błąd).

StorageInfo

Właściwości

  • quotaBytes

    liczba

  • usageBytes

    liczba

SyncAction

Typ wyliczeniowy

„added”

„updated”

„deleted”

SyncDirection

Typ wyliczeniowy

"local_to_remote"

"remote_to_local"

Metody

getConflictResolutionPolicy()

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

Pobiera bieżące zasady rozwiązywania konfliktów.

Parametry

Zwroty

  • Chrome w wersji 117 lub nowszej

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

getFileStatus()

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

Zwraca FileStatus dla podanego fileEntry. Wartość stanu może być 'synced', 'pending' lub 'conflicting'. Pamiętaj, że stan 'conflicting' występuje tylko wtedy, gdy zasada rozwiązywania konfliktów usługi ma wartość 'manual'.

Parametry

  • fileEntry

    Wpis

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    (status: FileStatus) => void

Zwroty

  • Promise<FileStatus>

    Chrome w wersji 117 lub nowszej

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

getFileStatuses()

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

Zwraca każdy element FileStatus w danej tablicy fileEntry. Zwykle jest wywoływany z wynikiem z dirReader.readEntries().

Parametry

  • fileEntries

    object[]

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    (status: FileStatusInfo[]) => void

Zwroty

  • Promise<FileStatusInfo[]>

    Chrome w wersji 117 lub nowszej

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

getServiceStatus()

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

Zwraca bieżący stan synchronizacji w backendzie.

Parametry

Zwroty

  • Promise<ServiceStatus>

    Chrome w wersji 117 lub nowszej

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

getUsageAndQuota()

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

Zwraca bieżące wykorzystanie i limit miejsca na dane w plikach 'syncable' w aplikacji w bajtach.

Parametry

  • fileSystem

    DOMFileSystem

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    (info: StorageInfo) => void

Zwroty

  • Obietnice<StorageInfo>

    Chrome w wersji 117 lub nowszej

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

requestFileSystem()

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

Zwraca system plików, który można zsynchronizować z Dyskiem Google. Z zwróconym obiektem DOMFileSystem można pracować tak samo jak z tymczasowymi i trwałymi systemami plików (patrz http://dev.w3.org/2009/dap/file-system/file-dir-sys.html).

Wywołanie tej funkcji kilka razy z tej samej aplikacji spowoduje zwrócenie tego samego identyfikatora do tego samego systemu plików.

Pamiętaj, że wywołanie może się nie udać. Może się tak zdarzyć, jeśli użytkownik nie jest zalogowany w Chrome lub sieć nie działa. Aby obsłużyć te błędy, w funkcji zwracającej wywołanie zwrotne należy sprawdzić zmienną chrome.runtime.lastError.

Parametry

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback ma postać:

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

Zwroty

  • Promise<DOMFileSystem>

    Chrome w wersji 117 lub nowszej

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

setConflictResolutionPolicy()

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

Ustawia domyślne zasady rozwiązywania konfliktów dotyczących miejsca na pliki 'syncable' w aplikacji. Domyślnie jest to wartość 'last_write_win'. Gdy zasada rozwiązywania konfliktów ma wartość 'last_write_win', konflikty dotyczące istniejących plików są automatycznie rozwiązywane przy następnej aktualizacji pliku. Opcjonalnie można podać parametr callback, aby dowiedzieć się, czy żądanie zostało zrealizowane.

Parametry

Zwroty

  • Obietnica<void>

    Chrome w wersji 117 lub nowszej

    Obietnice są obsługiwane tylko w przypadku pliku manifestu w wersji 3 lub nowszej, na innych platformach należy używać wywołań zwrotnych.

Wydarzenia

onFileStatusChanged

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

Wywoływane, gdy plik został zaktualizowany przez usługę synchronizacji w tle.

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback ma postać:

    (detail: FileInfo) => void

onServiceStatusChanged

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

Wywoływany, gdy wystąpił błąd lub inna zmiana stanu w systemie synchronizacji (na przykład gdy synchronizacja jest tymczasowo wyłączona z powodu błędu sieci lub uwierzytelniania).

Parametry

  • wywołanie zwrotne

    funkcja

    Parametr callback ma postać:

    (detail: ServiceInfo) => void