説明
chrome.syncFileSystem API を使用して、Google ドライブにデータを保存して同期します。この API は、Google ドライブに保存されている任意のユーザー ドキュメントにアクセスするためのものではありません。オフラインやキャッシュ保存用にアプリ固有の同期可能なストレージを提供し、同じデータを異なるクライアント間で利用できるようにします。この API の使用方法については、データの管理をご覧ください。
権限
syncFileSystem型
ConflictResolutionPolicy
列挙型
"last_write_win"
"manual"
FileInfo
プロパティ
-
アクション
SyncAction 省略可
onFileStatusChangedイベントを発生させるために実行された同期アクション。アクション値は'added'、'updated'、'deleted'のいずれかです。ステータスが'synced'の場合にのみ適用されます。 -
direction
SyncDirection 省略可
onFileStatusChangedイベントの同期方向。同期方向の値は'local_to_remote'または'remote_to_local'です。ステータスが'synced'の場合にのみ適用されます。 -
fileEntry
エントリ
ステータスが変更されたターゲット ファイルの
fileEntry。同期されたファイルの名前とパスの情報が含まれます。ファイルを削除すると、fileEntryの情報は引き続き利用できますが、ファイルは存在しなくなります。 -
ステータス
onFileStatusChangedイベント後のファイル ステータス。ステータス値は'synced'、'pending'、'conflicting'のいずれかです。
FileStatus
列挙型
「同期済み」
競合がなく、保留中のローカル変更がない。
"pending"
同期されていない保留中のローカル変更が 1 つ以上あります。
"conflicting"
ファイルがリモート バージョンと競合しているため、手動で解決する必要があります。
FileStatusInfo
プロパティ
-
エラー
文字列 省略可
指定されたファイルの FileStatus の取得中に問題が発生した場合にのみ返されるオプションのエラー。
-
fileEntry
エントリ
getFileStatuses に最初に渡されたエントリの 1 つ。
-
ステータス
ステータス値は
'synced'、'pending'、'conflicting'のいずれかです。
ServiceInfo
プロパティ
-
description
文字列
-
state
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()
chrome.syncFileSystem.getConflictResolutionPolicy(
callback?: function,
): Promise<ConflictResolutionPolicy>
現在の競合解決ポリシーを取得します。
パラメータ
-
callback
function 省略可
callbackパラメータは次のようになります。(policy: ConflictResolutionPolicy) => void
戻り値
-
Promise<ConflictResolutionPolicy>
Chrome 117 以降Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。
getFileStatus()
chrome.syncFileSystem.getFileStatus(
fileEntry: Entry,
callback?: function,
): Promise<FileStatus>
指定された fileEntry の FileStatus を返します。ステータス値は 'synced'、'pending'、'conflicting' のいずれかです。'conflicting' 状態は、サービスの競合解決ポリシーが 'manual' に設定されている場合にのみ発生します。
パラメータ
-
fileEntry
エントリ
-
callback
function 省略可
callbackパラメータは次のようになります。(status: FileStatus) => void
-
ステータス
-
戻り値
-
Promise<FileStatus>
Chrome 117 以降Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。
getFileStatuses()
chrome.syncFileSystem.getFileStatuses(
fileEntries: object[],
callback?: function,
): Promise<FileStatusInfo[]>
指定された fileEntry 配列の各 FileStatus を返します。通常は、dirReader.readEntries() の結果とともに呼び出されます。
パラメータ
-
fileEntries
object[]
-
callback
function 省略可
callbackパラメータは次のようになります。(status: FileStatusInfo[]) => void
-
ステータス
-
戻り値
-
Promise<FileStatusInfo[]>
Chrome 117 以降Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。
getServiceStatus()
chrome.syncFileSystem.getServiceStatus(
callback?: function,
): Promise<ServiceStatus>
現在の同期バックエンドのステータスを返します。
パラメータ
-
callback
function 省略可
callbackパラメータは次のようになります。(status: ServiceStatus) => void
-
ステータス
-
戻り値
-
Promise<ServiceStatus>
Chrome 117 以降Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。
getUsageAndQuota()
chrome.syncFileSystem.getUsageAndQuota(
fileSystem: DOMFileSystem,
callback?: function,
): Promise<StorageInfo>
アプリの 'syncable' ファイル ストレージの現在の使用量と割り当てをバイト単位で返します。
パラメータ
-
fileSystem
DOMFileSystem
-
callback
function 省略可
callbackパラメータは次のようになります。(info: StorageInfo) => void
-
情報
-
戻り値
-
Promise<StorageInfo>
Chrome 117 以降Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。
requestFileSystem()
chrome.syncFileSystem.requestFileSystem(
callback?: function,
): Promise<DOMFileSystem>
Google ドライブを基盤とする、同期可能なファイル システムを返します。返された DOMFileSystem インスタンスは、一時ファイル システムや永続ファイル システムと同じ方法で操作できます（http://dev.w3.org/2009/dap/file-system/file-dir-sys.html を参照）。
同じアプリからこのメソッドを複数回呼び出すと、同じファイル システムに対して同じハンドルが返されます。
この呼び出しは失敗する可能性があります。たとえば、ユーザーが Chrome にログインしていない場合や、ネットワーク オペレーションがない場合です。これらのエラーを処理するには、コールバックで chrome.runtime.lastError がチェックされていることが重要です。
パラメータ
-
callback
function 省略可
callbackパラメータは次のようになります。(fileSystem: DOMFileSystem) => void
-
fileSystem
DOMFileSystem
-
戻り値
-
Promise<DOMFileSystem>
Chrome 117 以降Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。
setConflictResolutionPolicy()
chrome.syncFileSystem.setConflictResolutionPolicy(
policy: ConflictResolutionPolicy,
callback?: function,
): Promise<void>
アプリの 'syncable' ファイル ストレージのデフォルトの競合解決ポリシーを設定します。デフォルトでは 'last_write_win' に設定されています。競合解決ポリシーが 'last_write_win' に設定されている場合、既存のファイルの競合は、次回ファイルが更新されるときに自動的に解決されます。callback を指定すると、リクエストが成功したかどうかを確認できます。
パラメータ
-
callback
function 省略可
callbackパラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 117 以降Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。
イベント
onFileStatusChanged
chrome.syncFileSystem.onFileStatusChanged.addListener(
callback: function,
)
バックグラウンド同期サービスによってファイルが更新されたときに呼び出されます。
onServiceStatusChanged
chrome.syncFileSystem.onServiceStatusChanged.addListener(
callback: function,
)
同期バックエンドでエラーまたはその他のステータス変更が発生したときに呼び出されます（たとえば、ネットワーク エラーまたは認証エラーにより同期が一時的に無効になった場合）。
パラメータ
-
callback
関数
callbackパラメータは次のようになります。(detail: ServiceInfo) => void
-
詳細
-