chrome.syncFileSystem

Descrizione

Utilizza l'API chrome.syncFileSystem per salvare e sincronizzare i dati su Google Drive. Questa API NON è destinata all'accesso a documenti utente arbitrari archiviati su Google Drive. Fornisce spazio di archiviazione sincronizzabile specifico per l'app per l'utilizzo offline e della cache, in modo che gli stessi dati siano disponibili su client diversi. Per saperne di più sull'utilizzo di questa API, leggi Gestire i dati.

Autorizzazioni

syncFileSystem

Tipi

ConflictResolutionPolicy

Enum

"last_write_win"

"manual"

FileInfo

Proprietà

  • azione

    SyncAction facoltativo

    Azione di sincronizzazione intrapresa per attivare l'evento onFileStatusChanged. Il valore dell'azione può essere 'added', 'updated' o 'deleted'. Si applica solo se lo stato è 'synced'.

  • direction

    SyncDirection facoltativo

    Direzione di sincronizzazione per l'evento onFileStatusChanged. Il valore della direzione di sincronizzazione può essere 'local_to_remote' o 'remote_to_local'. Si applica solo se lo stato è 'synced'.

  • fileEntry

    Voce

    fileEntry per il file di destinazione il cui stato è cambiato. Contiene informazioni sul nome e sul percorso del file sincronizzato. Al momento dell'eliminazione del file, le informazioni su fileEntry saranno ancora disponibili, ma il file non esisterà più.

  • stato

    FileStatus

    Stato del file risultante dopo l'evento onFileStatusChanged. Il valore dello stato può essere 'synced', 'pending' o 'conflicting'.

FileStatus

Enum

"Sincronizzato"
Non in conflitto e senza modifiche locali in attesa.

"pending"
Sono presenti una o più modifiche locali in attesa che non sono state sincronizzate.

"conflicting"
Il file è in conflitto con la versione remota e deve essere risolto manualmente.

FileStatusInfo

Proprietà

  • errore

    stringa facoltativa

    Errore facoltativo restituito solo se si è verificato un problema durante il recupero del FileStatus per il file specificato.

  • fileEntry

    Voce

    Uno degli elementi dell'elemento Entry originariamente assegnato a getFileStatuses.

  • stato

    FileStatus

    Il valore dello stato può essere 'synced', 'pending' o 'conflicting'.

ServiceInfo

Proprietà

ServiceStatus

Enum

"initializing"
Il servizio di sincronizzazione è in fase di inizializzazione (ad es. ripristino dei dati dal database, verifica della connettività e autenticazione al servizio e così via).

"running"
Il servizio di sincronizzazione è attivo e funzionante.

"authentication_required"
Il servizio di sincronizzazione non sincronizza i file perché il servizio remoto deve essere autenticato dall'utente per procedere.

"temporary_unavailable"
Il servizio di sincronizzazione non sincronizza i file perché il servizio remoto non è (temporaneamente) disponibile a causa di alcuni errori recuperabili, ad esempio la rete è offline, il servizio remoto non è attivo o non è raggiungibile e così via. Ulteriori dettagli devono essere forniti dal parametro description in OnServiceInfoUpdated (che potrebbe contenere dettagli specifici del servizio).

"disabled"
Il servizio di sincronizzazione è disattivato e i contenuti non verranno mai sincronizzati. Ad esempio, questo potrebbe accadere se l'utente non ha un account sul servizio remoto o se il servizio di sincronizzazione ha riscontrato un errore non recuperabile.

StorageInfo

Proprietà

  • quotaBytes

    numero

  • usageBytes

    numero

SyncAction

Enum

"added"

"updated"

"deleted"

SyncDirection

Enum

"local_to_remote"

"remote_to_local"

Metodi

getConflictResolutionPolicy()

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

Recupera il criterio di risoluzione dei conflitti corrente.

Parametri

Resi

  • Chrome 117 e versioni successive

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getFileStatus()

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

Restituisce FileStatus per il fileEntry specificato. Il valore dello stato può essere 'synced', 'pending' o 'conflicting'. Tieni presente che lo stato 'conflicting' si verifica solo quando il criterio di risoluzione dei conflitti del servizio è impostato su 'manual'.

Parametri

  • fileEntry

    Voce

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    (status: FileStatus) => void

Resi

  • Promise<FileStatus>

    Chrome 117 e versioni successive

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getFileStatuses()

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

Restituisce ogni FileStatus per l'array fileEntry specificato. Viene chiamato in genere con il risultato di dirReader.readEntries().

Parametri

  • fileEntries

    object[]

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    (status: FileStatusInfo[]) => void

Resi

  • Promise<FileStatusInfo[]>

    Chrome 117 e versioni successive

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getServiceStatus()

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

Restituisce lo stato attuale del backend di sincronizzazione.

Parametri

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    (status: ServiceStatus) => void

Resi

  • Promise<ServiceStatus>

    Chrome 117 e versioni successive

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getUsageAndQuota()

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

Restituisce l'utilizzo e la quota attuali in byte per lo spazio di archiviazione dei file 'syncable' per l'app.

Parametri

  • fileSystem

    DOMFileSystem

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    (info: StorageInfo) => void

Resi

  • Promise<StorageInfo>

    Chrome 117 e versioni successive

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

requestFileSystem()

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

Restituisce un file system sincronizzabile basato su Google Drive. L'istanza DOMFileSystem restituita può essere utilizzata nello stesso modo dei file system temporanei e permanenti (vedi http://dev.w3.org/2009/dap/file-system/file-dir-sys.html).

Se la chiami più volte dalla stessa app, verrà restituito lo stesso handle allo stesso file system.

Tieni presente che questa chiamata può non riuscire. Ad esempio, se l'utente non ha eseguito l'accesso a Chrome o se non è in corso alcuna operazione di rete. Per gestire questi errori, è importante che chrome.runtime.lastError venga controllato nel callback.

Parametri

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

Resi

  • Promise<DOMFileSystem>

    Chrome 117 e versioni successive

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

setConflictResolutionPolicy()

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

Imposta il criterio di risoluzione dei conflitti predefinito per lo spazio di archiviazione dei file 'syncable' per l'app. Per impostazione predefinita, è impostato su 'last_write_win'. Quando il criterio di risoluzione dei conflitti è impostato su 'last_write_win', i conflitti per i file esistenti vengono risolti automaticamente al successivo aggiornamento del file. Se vuoi, puoi specificare callback per sapere se la richiesta è andata a buon fine o meno.

Parametri

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise<void>

    Chrome 117 e versioni successive

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

Eventi

onFileStatusChanged

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

Viene attivato quando un file è stato aggiornato dal servizio di sincronizzazione in background.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (detail: FileInfo) => void

onServiceStatusChanged

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

Viene attivato quando si verifica un errore o un'altra modifica dello stato nel backend di sincronizzazione (ad esempio quando la sincronizzazione è temporaneamente disattivata a causa di un errore di rete o di autenticazione).

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (detail: ServiceInfo) => void