chrome.syncFileSystem

說明

使用 chrome.syncFileSystem API 在 Google 雲端硬碟上儲存及同步資料。這個 API 無法用於存取儲存在 Google 雲端硬碟中的任意使用者文件。它提供應用程式專用的可同步儲存空間，可用於離線和快取用途，讓不同用戶端都能使用相同的資料。如要進一步瞭解如何使用這個 API，請參閱「管理資料」。

權限

syncFileSystem

類型

ConflictResolutionPolicy

列舉

"last_write_win"

"manual"

FileInfo

屬性

  • 動作

    SyncAction 選填

    觸發 onFileStatusChanged 事件的同步處理動作。動作值可以是 'added'、'updated' 或 'deleted'。只有在狀態為 'synced' 時才會套用。

  • 方向

    SyncDirection 選填

    onFileStatusChanged 事件的同步方向。同步方向值可以是 'local_to_remote' 或 'remote_to_local'。只有在狀態為 'synced' 時才會套用。

  • fileEntry

    項目

    fileEntry 的狀態已變更的目標檔案。包含同步處理檔案的名稱和路徑資訊。刪除檔案後，fileEntry 資訊仍會保留，但檔案將不再存在。

  • 狀態

    FileStatus

    onFileStatusChanged 事件後的最終檔案狀態。狀態值可以是 'synced'、'pending' 或 'conflicting'。

FileStatus

列舉

「已同步」
沒有衝突，且沒有待處理的本機變更。

「pending」
有一或多項未同步的待處理本機變更。

「conflicting」
檔案與遠端版本發生衝突，必須以人工方式解決。

FileStatusInfo

屬性

  • 錯誤

    string 選填

    只有在擷取指定檔案的 FileStatus 時發生問題時，系統才會傳回這個選用錯誤。

  • fileEntry

    項目

    最初提供給 getFileStatuses 的 Entry 之一。

  • 狀態

    FileStatus

    狀態值可以是 'synced'、'pending' 或 'conflicting'。

ServiceInfo

屬性

ServiceStatus

列舉

「initializing」
同步服務正在初始化 (例如從資料庫還原資料、檢查連線情形和服務驗證等)。

「running」
同步處理服務已啟用。

"authentication_required"
由於遠端服務需要經過使用者驗證才能繼續，因此同步處理服務不會同步處理檔案。

"temporary_unavailable"
由於發生一些可復原的錯誤 (例如網路離線、遠端服務異常或無法存取)，因此同步處理服務無法 (暫時) 使用，因此不會同步處理檔案。OnServiceInfoUpdated 中的 description 參數應提供更多詳細資料 (可能包含服務專屬詳細資料)。

"disabled"
同步服務已停用，內容永遠不會同步。(例如，當使用者在遠端服務上沒有帳戶，或是同步服務發生無法復原的錯誤時，就可能發生這種情況)。

StorageInfo

屬性

  • quotaBytes

    數字

  • usageBytes

    數字

SyncAction

列舉

"added"

「updated」

"deleted"

SyncDirection

列舉

"local_to_remote"

"remote_to_local"

方法

getConflictResolutionPolicy()

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

取得目前的衝突解決政策。

參數

傳回

  • Chrome 117 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getFileStatus()

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

傳回指定 fileEntry 的 FileStatus。狀態值可以是 'synced'、'pending' 或 'conflicting'。請注意，只有在服務的衝突解決政策設為 'manual' 時，才會出現 'conflicting' 狀態。

參數

  • fileEntry

    項目

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (status: FileStatus) => void

傳回

  • Promise<FileStatus>

    Chrome 117 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getFileStatuses()

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

針對指定的 fileEntry 陣列傳回每個 FileStatus。通常會使用 dirReader.readEntries() 的結果呼叫。

參數

傳回

  • Promise<FileStatusInfo[]>

    Chrome 117 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getServiceStatus()

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

傳回目前的同步處理後端狀態。

參數

傳回

  • Promise<ServiceStatus>

    Chrome 117 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

getUsageAndQuota()

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

針對應用程式的 'syncable' 檔案儲存空間，傳回目前用量和配額 (以位元組為單位)。

參數

  • fileSystem

    DOMFileSystem

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (info: StorageInfo) => void

傳回

  • Promise<StorageInfo>

    Chrome 117 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

requestFileSystem()

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

傳回由 Google 雲端硬碟支援的同步處理檔案系統。您可以以與臨時和永久性檔案系統相同的方式操作傳回的 DOMFileSystem 例項 (請參閱 http://dev.w3.org/2009/dap/file-system/file-dir-sys.html)。

從同一個應用程式多次呼叫此方法，會將相同的句柄傳回至相同的檔案系統。

請注意，這個呼叫可能會失敗。例如，如果使用者未登入 Chrome，或沒有網路操作，如要處理這些錯誤，請務必在回呼中檢查 chrome.runtime.lastError。

參數

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (fileSystem: DOMFileSystem) => void

    • fileSystem

      DOMFileSystem

傳回

  • Promise<DOMFileSystem>

    Chrome 117 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

setConflictResolutionPolicy()

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

為應用程式的 'syncable' 檔案儲存空間設定預設衝突解決政策。預設為 'last_write_win'。當衝突解決政策設為 'last_write_win' 時，系統會在下次更新現有檔案時自動解決衝突。您可以選擇提供 callback，以便瞭解要求是否成功。

參數

傳回

  • Promise<void>

    Chrome 117 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需要使用回呼。

活動

onFileStatusChanged

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

當背景同步處理服務更新檔案時觸發。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    (detail: FileInfo) => void

onServiceStatusChanged

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

在同步處理後端發生錯誤或其他狀態變更時觸發 (例如，當同步處理因網路或驗證錯誤而暫時停用時)。

參數