chrome.syncFileSystem

Descripción

Usa la API de chrome.syncFileSystem para guardar y sincronizar datos en Google Drive. Esta API NO se usa para acceder a documentos arbitrarios del usuario almacenados en Google Drive. Proporciona almacenamiento sincronizable específico de la app para el uso sin conexión y en caché, de modo que los mismos datos puedan estar disponibles en diferentes clientes. Consulta Administra datos para obtener más información sobre el uso de esta API.

Permisos

syncFileSystem

Tipos

ConflictResolutionPolicy

Enum

"last_write_win"

“manual”

FileInfo

Propiedades

  • acción

    SyncAction opcional

    Se realizó una acción de sincronización para activar el evento onFileStatusChanged. El valor de la acción puede ser 'added', 'updated' o 'deleted'. Solo se aplica si el estado es 'synced'.

  • dirección

    SyncDirection opcional

    Sincroniza la dirección del evento onFileStatusChanged. El valor de dirección de sincronización puede ser 'local_to_remote' o 'remote_to_local'. Solo se aplica si el estado es 'synced'.

  • fileEntry

    Entrada

    fileEntry para el archivo de destino cuyo estado cambió. Contiene información sobre el nombre y la ruta de acceso del archivo sincronizado. Cuando se borre el archivo, la información de fileEntry seguirá disponible, pero el archivo ya no existirá.

  • estado

    FileStatus

    Estado del archivo resultante después del evento onFileStatusChanged. El valor de estado puede ser 'synced', 'pending' o 'conflicting'.

FileStatus

Enum

"synced"
No en conflicto y no tiene cambios locales pendientes.

"pending"
Tiene uno o más cambios locales pendientes que no se sincronizaron.

"conflicting"
Los archivos están en conflicto con la versión remota y deben resolverse manualmente.

FileStatusInfo

Propiedades

  • error

    string opcional

    Error opcional que solo se muestra si hubo un problema cuando se recuperaba FileStatus para el archivo especificado.

  • fileEntry

    Entrada

    Uno de los objetos Entry que se le proporcionó originalmente a getFileStatuses.

  • estado

    FileStatus

    El valor de estado puede ser 'synced', 'pending' o 'conflicting'.

ServiceInfo

Propiedades

ServiceStatus

Enum

"inicializando"
Se está inicializando el servicio de sincronización (p.ej., para restablecer datos de la base de datos, verificar la conectividad y autenticarte en el servicio, etcétera).

"running"
El servicio de sincronización está activo.

"authentication_required"
El servicio de sincronización no sincroniza los archivos porque el usuario debe autenticar el servicio remoto para continuar.

"Temporary_unavailable"
El servicio de sincronización no sincroniza los archivos porque el servicio remoto no está disponible (temporalmente) debido a algunos errores que se pueden recuperar; p.ej., La red está sin conexión, el servicio remoto no funciona o no es accesible, etc. El parámetro description debe proporcionar más detalles en OnServiceInfoUpdated (que podría contener detalles específicos del servicio).

"disable"
El servicio de sincronización está inhabilitado y el contenido nunca se sincronizará. (p.ej., esto puede ocurrir cuando el usuario no tiene una cuenta en el servicio remoto o cuando el servicio de sincronización experimenta un error irrecuperable).

StorageInfo

Propiedades

  • quotaBytes

    número

  • usageBytes

    número

SyncAction

Enum

“agregado”

“actualizado”

“eliminado”

SyncDirection

Enum

"local_to_remote"

"remote_to_local"

Métodos

getConflictResolutionPolicy()

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

Obtiene la política de resolución de conflictos actual.

Parámetros

Muestra

  • Promise<ConflictResolutionPolicy>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getFileStatus()

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

Muestra el FileStatus de la fileEntry especificada. El valor de estado puede ser 'synced', 'pending' o 'conflicting'. Ten en cuenta que el estado 'conflicting' solo ocurre cuando la política de resolución de conflictos del servicio se establece en 'manual'.

Parámetros

  • fileEntry

    Entrada

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (status: FileStatus) => void

Muestra

  • Promise<FileStatus>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getFileStatuses()

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

Muestra cada FileStatus para el array fileEntry determinado. Por lo general, se llama con el resultado de dirReader.readEntries().

Parámetros

  • fileEntries

    object[]

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (status: FileStatusInfo[]) => void

Muestra

  • Promise<FileStatusInfo[]>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getServiceStatus()

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

Muestra el estado del backend de sincronización actual.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (status: ServiceStatus) => void

Muestra

  • Promise<ServiceStatus>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getUsageAndQuota()

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

Muestra el uso y la cuota actuales en bytes para el almacenamiento de archivos 'syncable' de la app.

Parámetros

  • fileSystem

    DOMFileSystem

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (info: StorageInfo) => void

Muestra

  • Promise<StorageInfo>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

requestFileSystem()

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

Devuelve un sistema de archivos sincronizable respaldado por Google Drive. Se puede operar la instancia DOMFileSystem que se muestra de la misma manera que los sistemas de archivos temporales y persistentes (consulta http://dev.w3.org/2009/dap/file-system/file-dir-sys.html).

Si llamas a esto varias veces desde la misma app, se mostrará el mismo controlador en el mismo sistema de archivos.

Ten en cuenta que esta llamada puede fallar. Por ejemplo, si el usuario no accedió a Chrome o si no hay operación de red. Para manejar estos errores, es importante que se verifique chrome.runtime.lastError en la devolución de llamada.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

Muestra

  • Promise<DOMFileSystem>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

setConflictResolutionPolicy()

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

Establece la política de resolución de conflictos predeterminada para el almacenamiento de archivos 'syncable' de la app. De forma predeterminada, se establece en 'last_write_win'. Cuando la política de resolución de conflictos se establece en 'last_write_win', los conflictos de los archivos existentes se resuelven automáticamente la próxima vez que se actualice el archivo. De manera opcional, se puede proporcionar callback para saber si la solicitud se realizó correctamente o no.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

Eventos

onFileStatusChanged

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

Se activa cuando el servicio de sincronización en segundo plano actualiza un archivo.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (detail: FileInfo) => void

onServiceStatusChanged

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

Se activa cuando se produce un error o algún otro cambio de estado en el backend de sincronización (por ejemplo, cuando la sincronización se inhabilita temporalmente debido a un error de red o de autenticación).

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (detail: ServiceInfo) => void