chrome.syncFileSystem

説明

chrome.syncFileSystem API を使用して、Google ドライブに保存して同期します。この API は、Google ドライブに保存されている任意のユーザー ドキュメントへのアクセスを目的としたものではありません。オフラインやキャッシュ用にアプリ固有の同期可能なストレージが提供されるため、異なるクライアント間で同じデータを使用できます。この API の使用方法について詳しくは、データの管理をご覧ください。

権限

syncFileSystem

型

ConflictResolutionPolicy

Enum

"manual"

FileInfo

プロパティ

• action

  SyncAction 省略可

  onFileStatusChanged イベントを発生させた同期アクション。アクションの値は、'added'、'updated'、'deleted' のいずれかです。ステータスが 'synced' の場合にのみ適用されます。

• direction

  SyncDirection 省略可

  onFileStatusChanged イベントの同期方向。同期方向の値は 'local_to_remote' または 'remote_to_local' です。ステータスが 'synced' の場合にのみ適用されます。

• fileEntry

  エントリ

  ステータスが変更されたターゲット ファイルに対する fileEntry。同期ファイルの名前とパスの情報が含まれます。ファイルの削除時、fileEntry の情報は引き続き利用できますが、ファイルは存在しません。

• status

  FileStatus

  onFileStatusChanged イベントの後の結果ファイルのステータス。ステータス値は、'synced'、'pending'、'conflicting' のいずれかです。

FileStatus

Enum

"synced"
競合しておらず、保留中のローカル変更はありません。

"pending"
同期されていない保留中のローカル変更があります。

"conflicting"
ファイルがリモート バージョンと競合しているため、手動で解決する必要があります。

FileStatusInfo

プロパティ

• error

  string（省略可）

  指定されたファイルの FileStatus の取得中に問題が発生した場合にのみ返される省略可能なエラー。

• fileEntry

  エントリ

  もともと getFileStatuses に渡された Entry の 1 つです。

• status

  FileStatus

  ステータス値は、'synced'、'pending'、'conflicting' のいずれかです。

ServiceInfo

プロパティ

• description

  文字列

• state

  ServiceStatus

ServiceStatus

Enum

"initializing"
同期サービスの初期化中です（データベースからのデータの復元、サービスへの接続のチェックと認証など）。

"running"
同期サービスが起動して実行中です。

"authentication_required"
リモート サービスを続行するにはユーザーが認証する必要があるため、同期サービスはファイルを同期していません。

"temporary_unavailable"
復元可能なエラー（ネットワークがオフライン、リモート サービスがダウンしている、または到達できないなど）によりリモート サービスが（一時的に）利用できないため、同期サービスはファイルを同期していません。詳細については、OnServiceInfoUpdated の description パラメータで指定する必要があります（サービス固有の詳細を含めることができます）。

"disabled"
同期サービスが無効になり、コンテンツは同期されません。（たとえば、ユーザーがリモート サービスのアカウントを持っていない場合や、同期サービスに回復不能なエラーが発生した場合など）。

StorageInfo

プロパティ

• quotaBytes

  数値

• usageBytes

  数値

SyncAction

Enum

SyncDirection

Enum

"local_to_remote"

"remote_to_local"

Methods

getConflictResolutionPolicy()

Promise

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

現在の競合解決ポリシーを取得します。

パラメータ

• callback

  関数（省略可）

  callback パラメータは次のようになります。

  (policy: ConflictResolutionPolicy)=>void

  • policy

    ConflictResolutionPolicy

戻り値

• Promise<ConflictResolutionPolicy>

  Chrome 117 以降

  Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getFileStatus()

Promise

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

指定された fileEntry の FileStatus を返します。ステータス値は、'synced'、'pending'、'conflicting' のいずれかです。'conflicting' 状態は、サービスの競合解決ポリシーが 'manual' に設定されている場合にのみ発生します。

パラメータ

• fileEntry

  エントリ

• callback

  関数（省略可）

  callback パラメータは次のようになります。

  (status: FileStatus)=>void

  • status

    FileStatus

戻り値

• Promise<FileStatus>

  Chrome 117 以降

  Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getFileStatuses()

Promise

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

指定された fileEntry 配列の各 FileStatus を返します。通常は、dirReader.readEntries() の結果を使用して呼び出されます。

パラメータ

• fileEntries

  オブジェクト []

• callback

  関数（省略可）

  callback パラメータは次のようになります。

  (status: FileStatusInfo[])=>void

  • status

    FileStatusInfo[]

戻り値

• Promise<FileStatusInfo[]>

  Chrome 117 以降

  Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getServiceStatus()

Promise

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

現在の同期バックエンドのステータスを返します。

パラメータ

• callback

  関数（省略可）

  callback パラメータは次のようになります。

  (status: ServiceStatus)=>void

  • status

    ServiceStatus

戻り値

• Promise<ServiceStatus>

  Chrome 117 以降

  Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getUsageAndQuota()

Promise

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

アプリの 'syncable' ファイル ストレージの現在の使用量と割り当て（バイト単位）を返します。

パラメータ

• fileSystem

  DOMFileSystem

• callback

  関数（省略可）

  callback パラメータは次のようになります。

  (info: StorageInfo)=>void

  • 情報

    StorageInfo

戻り値

• Promise<StorageInfo>

  Chrome 117 以降

  Promise は Manifest 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

  関数（省略可）

  callback パラメータは次のようになります。

  (fileSystem: DOMFileSystem)=>void

  • fileSystem

    DOMFileSystem

戻り値

• Promise<DOMFileSystem>

  Chrome 117 以降

  Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

setConflictResolutionPolicy()

Promise

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

アプリの 'syncable' ファイル ストレージのデフォルトの競合解決ポリシーを設定します。デフォルトでは 'last_write_win' に設定されています。競合解決ポリシーが 'last_write_win' に設定されている場合、既存のファイルの競合は次回のファイル更新時に自動的に解決されます。オプションで callback を指定すると、リクエストが成功したかどうかを確認できます。

パラメータ

• policy

  ConflictResolutionPolicy

• callback

  関数（省略可）

  callback パラメータは次のようになります。

  ()=>void

戻り値

• Promise<void>

  Chrome 117 以降

  Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

イベント

onFileStatusChanged

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

バックグラウンド同期サービスによってファイルが更新されたときに呼び出されます。

パラメータ

• callback

  機能

  callback パラメータは次のようになります。

  (detail: FileInfo)=>void

  • 詳細

    FileInfo

onServiceStatusChanged

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

同期バックエンドでエラーやその他のステータスの変更が発生したときに呼び出されます（ネットワークまたは認証エラーが原因で同期が一時的に無効になっている場合など）。

パラメータ

• callback

  機能

  callback パラメータは次のようになります。

  (detail: ServiceInfo)=>void

  • 詳細

    ServiceInfo