chrome.fileSystemProvider

更新日: 2026-09-25 robots: noindex

重要: この API は ChromeOS でのみ動作します。

説明

chrome.fileSystemProvider API を使用して、Chrome OS のファイル マネージャーからアクセスできるファイル システムを作成します。

権限

fileSystemProvider

対象

ChromeOS のみ

マニフェスト

File System Provider API を使用するには、拡張機能マニフェストで「fileSystemProvider」権限とセクションを宣言する必要があります。次に例を示します。

{
  "name": "My extension",
  ...
  "permissions": [
    "fileSystemProvider"
  ],
  ...
  "file_system_provider_capabilities": {
    "configurable": true,
    "watchable": false,
    "multiple_mounts": true,
    "source": "network"
  },
  ...
}

file_system_provider セクションは、次のように宣言する必要があります。

configurable（ブール値） - 省略可

onConfigureRequested を介した構成がサポートされているかどうか。デフォルト: false。

multiple_mounts（ブール値） - 省略可

複数の（1 つ以上の）マウントされたファイル システムがサポートされているかどうか。デフォルト: false。

watchable（ブール値） - 省略可

ウォッチャーの設定と変更に関する通知がサポートされているかどうか。デフォルト: false。

source（「file」、「device」、「network」の列挙型） - 必須

マウントされたファイル システムのデータソース。

ファイルアプリは、上記の情報を使用して、関連する UI 要素を適切にレンダリングします。たとえば、configurable が true に設定されている場合、ボリュームを構成するためのメニュー項目がレンダリングされます。同様に、multiple_mounts が true に設定されている場合、ファイルアプリでは UI から複数のマウント ポイントを追加できます。watchable が false の場合、更新ボタンがレンダリングされます。可能であれば、ファイル システムの変更がすぐに自動的に反映されるように、ウォッチャーのサポートを追加する必要があります。

概要

File System Provider API を使用すると、拡張機能で仮想ファイル システムをサポートできます。仮想ファイル システムは、ChromeOS のファイル マネージャーで使用できます。ユースケースには、アーカイブの解凍や、ドライブ以外のクラウド サービス内のファイルへのアクセスなどがあります。

ファイル システムをマウントする

拡張機能を提供することで、外部ソース（リモート サーバーや USB デバイスなど）からファイル システムのコンテンツを提供したり、ローカル ファイル（アーカイブなど）を入力として使用したりできます。

ファイル ハンドラであるファイル システム（ソースは "file"）を書き込むには、プロバイダがパッケージ化アプリである必要があります。onLaunched イベントは拡張機能では使用できないためです。

ソースがネットワークまたはデバイスの場合、onMountRequested イベントが呼び出されたときにファイル システムをマウントする必要があります。

ファイル システム データのソース	エントリ ポイント
"file"	パッケージ化されたアプリでのみ使用できます。
"device" または "network"	onMountRequested

ファイル システムの構成

提供されたファイル システムは、マウントされると、onConfigureRequested イベントを介して構成できます。これは、適切な認証情報を設定するために、ネットワーク経由でコンテンツを提供するファイル システムに特に役立ちます。このイベントの処理は任意です。

ライフサイクル

一度マウントされたファイル システムは Chrome に記憶され、再起動後に自動的に再マウントされます。そのため、提供元の拡張機能によってファイル システムがマウントされると、その拡張機能がアンロードされるか、拡張機能が unmount メソッドを呼び出すまで、ファイル システムは維持されます。

型

AbortRequestedOptions

プロパティ

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• operationRequestId

  数値

  中止するリクエストの ID。

• requestId

  数値

  このリクエストの固有識別子。

Action

Chrome 45 以降

プロパティ

• id

  文字列

  アクションの識別子。任意の文字列、または一般的なアクションの場合は CommonActionId。

• title

  文字列 省略可

  アクションのタイトル。一般的なアクションでは無視されることがあります。

AddWatcherRequestedOptions

プロパティ

• entryPath

  文字列

  監視するエントリのパス。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• recursive

  ブール値

  監視にすべての子エントリを再帰的に含めるかどうか。ディレクトリにのみ設定できます。

• requestId

  数値

  このリクエストの固有識別子。

Change

プロパティ

• changeType

  ChangeType

  エントリに発生した変更のタイプ。

• cloudFileInfo

  CloudFileInfo 省略可

  Chrome 125 以降

  クラウド ファイル システムを基盤とするファイルに関連する情報。

• entryPath

  文字列

  変更されたエントリのパス。

ChangeType

監視対象ディレクトリで検出された変更の種類。

列挙型

"CHANGED"

"DELETED"

CloseFileRequestedOptions

プロパティ

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• openRequestId

  数値

  ファイルを開くために使用されるリクエスト ID。

• requestId

  数値

  このリクエストの固有識別子。

CloudFileInfo

Chrome 125 以降

プロパティ

• versionTag

  文字列 省略可

  ファイルのバージョンを表すタグ。

CloudIdentifier

Chrome 117 以降

プロパティ

• id

  文字列

  指定されたファイル / ディレクトリのプロバイダの識別子。

• providerName

  文字列

  クラウド ストレージ プロバイダの識別子（例: 「drive.google.com」）。

CommonActionId

Chrome 45 以降

一般的なアクションのリスト。"SHARE" は、他のユーザーとファイルを共有するためのものです。"SAVE_FOR_OFFLINE": 固定（オフライン アクセス用に保存）"OFFLINE_NOT_NECESSARY": ファイルをオフライン アクセス用に保存する必要がなくなったことを通知します。onGetActionsRequested と onExecuteActionRequested で使用されます。

列挙型

"SAVE_FOR_OFFLINE"

"OFFLINE_NOT_NECESSARY"

「共有」

ConfigureRequestedOptions

Chrome 44 以降

プロパティ

• fileSystemId

  文字列

  構成するファイル システムの識別子。

• requestId

  数値

  このリクエストの固有識別子。

CopyEntryRequestedOptions

プロパティ

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• requestId

  数値

  このリクエストの固有識別子。

• sourcePath

  文字列

  コピーするエントリのソースパス。

• targetPath

  文字列

  コピー オペレーションの宛先パス。

CreateDirectoryRequestedOptions

プロパティ

• directoryPath

  文字列

  作成するディレクトリのパス。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• recursive

  ブール値

  オペレーションが再帰的かどうか（ディレクトリのみ）。

• requestId

  数値

  このリクエストの固有識別子。

CreateFileRequestedOptions

プロパティ

• filePath

  文字列

  作成するファイルのパス。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• requestId

  数値

  このリクエストの固有識別子。

DeleteEntryRequestedOptions

プロパティ

• entryPath

  文字列

  削除するエントリのパス。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• recursive

  ブール値

  オペレーションが再帰的かどうか（ディレクトリのみ）。

• requestId

  数値

  このリクエストの固有識別子。

EntryMetadata

プロパティ

• cloudFileInfo

  CloudFileInfo 省略可

  Chrome 125 以降

  基盤となるクラウド ファイル システム内の特定のファイルを識別する情報。options でリクエストされ、ファイルが Cloud Storage でバックアップされている場合は、指定する必要があります。

• cloudIdentifier

  CloudIdentifier 省略可

  Chrome 117 以降

  このエントリの Cloud Storage 表現。options でリクエストされ、ファイルがクラウド ストレージにバックアップされている場合は、指定する必要があります。クラウド ストレージにバックアップされていないローカル ファイルの場合、リクエスト時に未定義にする必要があります。

• isDirectory

  boolean 省略可

  ディレクトリの場合は true。options でリクエストされた場合は指定する必要があります。

• mimeType

  文字列 省略可

  エントリの MIME タイプ。常に省略可能ですが、options でリクエストされた場合は指定する必要があります。

• modificationTime

  日付（省略可）

  このエントリの最終更新日時。options でリクエストされた場合は指定する必要があります。

• name

  文字列 省略可

  このエントリの名前（フルパス名ではない）。「/」を含めることはできません。ルートの場合は空にする必要があります。options でリクエストされた場合は指定する必要があります。

• サイズ

  number 省略可

  ファイルサイズ（バイト単位）。options でリクエストされた場合は指定する必要があります。

• サムネイル

  文字列 省略可

  PNG、JPEG、WEBP のいずれかの形式のデータ URI としてのサムネイル画像。サイズは 32 KB 以下です。省略可能ですが、onGetMetadataRequested イベントによって明示的にリクエストされた場合にのみ指定できます。

ExecuteActionRequestedOptions

Chrome 45 以降

プロパティ

• actionId

  文字列

  実行するアクションの識別子。

• entryPaths

  string[]

  Chrome 47 以降

  アクションに使用するエントリのパスのセット。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• requestId

  数値

  このリクエストの固有識別子。

FileSystemInfo

プロパティ

• displayName

  文字列

  ファイル システムの人が読める形式の名前。

• fileSystemId

  文字列

  ファイル システムの ID。

• openedFiles

  OpenedFile[]

  現在開いているファイルのリスト。

• openedFilesLimit

  数値

  同時に開くことができるファイルの最大数。0 の場合、制限はありません。

• supportsNotifyTag

  boolean 省略可

  Chrome 45 以降

  ファイル システムがディレクトリを監視するための tag フィールドをサポートしているかどうか。

• watchers

  Watcher[]

  Chrome 45 以降

  ウォッチャーのリスト。

• 書き込み可能

  ブール値

  ファイル システムが、ファイル システムの内容を変更する可能性のあるオペレーション（ファイルの作成、削除、書き込みなど）をサポートしているかどうか。

GetActionsRequestedOptions

Chrome 45 以降

プロパティ

• entryPaths

  string[]

  Chrome 47 以降

  アクションのリストのエントリのパスのリスト。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• requestId

  数値

  このリクエストの固有識別子。

GetMetadataRequestedOptions

プロパティ

• cloudFileInfo

  ブール値

  Chrome 125 以降

  cloudFileInfo 値がリクエストされた場合は true に設定します。

• cloudIdentifier

  ブール値

  Chrome 117 以降

  cloudIdentifier 値がリクエストされた場合は true に設定します。

• entryPath

  文字列

  メタデータを取得するエントリのパス。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• isDirectory

  ブール値

  Chrome 49 以降

  is_directory 値がリクエストされた場合は true に設定します。

• mimeType

  ブール値

  Chrome 49 以降

  mimeType 値がリクエストされた場合は true に設定します。

• modificationTime

  ブール値

  Chrome 49 以降

  modificationTime 値がリクエストされた場合は true に設定します。

• name

  ブール値

  Chrome 49 以降

  name 値がリクエストされた場合は true に設定します。

• requestId

  数値

  このリクエストの固有識別子。

• サイズ

  ブール値

  Chrome 49 以降

  size 値がリクエストされた場合は true に設定します。

• サムネイル

  ブール値

  thumbnail 値がリクエストされた場合は true に設定します。

MountOptions

プロパティ

• displayName

  文字列

  ファイル システムの人が読める形式の名前。

• fileSystemId

  文字列

  ファイル システムの文字列識別子。拡張機能ごとに一意である必要があります。

• openedFilesLimit

  number 省略可

  同時に開くことができるファイルの最大数。指定しない場合、または 0 の場合は制限されません。

• 永続

  boolean 省略可

  Chrome 64 以降

  次のログイン セッションでフレームワークがファイル システムを再開するかどうか。デフォルトでは True です。

• supportsNotifyTag

  boolean 省略可

  Chrome 45 以降

  ファイル システムが、監視対象ディレクトリの tag フィールドをサポートしているかどうか。

• 書き込み可能

  boolean 省略可

  ファイル システムが、ファイル システムの内容を変更する可能性のあるオペレーション（ファイルの作成、削除、書き込みなど）をサポートしているかどうか。

MoveEntryRequestedOptions

プロパティ

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• requestId

  数値

  このリクエストの固有識別子。

• sourcePath

  文字列

  新しい場所に移動するエントリのソースパス。

• targetPath

  文字列

  コピー オペレーションの宛先パス。

NotifyOptions

プロパティ

• changeType

  ChangeType

  監視対象のエントリに発生した変更のタイプ。DELETED の場合、監視対象のエントリは監視対象エントリのリストから自動的に削除されます。

• 変更

  Change[] 省略可

  監視対象ディレクトリ内のエントリ（エントリ自体を含む）に対する変更のリスト

• fileSystemId

  文字列

  この変更に関連するファイル システムの ID。

• observedPath

  文字列

  モニタリング対象のエントリのパス。

• recursive

  ブール値

  モニタリング対象のエントリのモード。

• タグ

  文字列 省略可

  通知のタグ。ファイル システムが supportsNotifyTag オプションでマウントされている場合は必須です。このフラグは、システムがシャットダウンされた場合でも、変更に関する通知を提供するために必要です。

OpenedFile

プロパティ

• filePath

  文字列

  開いたファイルのパス。

• モード

  OpenFileMode

  ファイルが読み取り用に開かれたか、書き込み用に開かれたか。

• openRequestId

  数値

  連続する読み取り / 書き込みリクエストとクローズ リクエストで使用されるリクエスト ID。

OpenFileMode

ファイルを開くモード。onOpenFileRequested で使用されます。

列挙型

"READ"

"WRITE"

OpenFileRequestedOptions

プロパティ

• filePath

  文字列

  開くファイルのパス。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• モード

  OpenFileMode

  ファイルが読み取りまたは書き込みに使用されるかどうか。

• requestId

  数値

  連続する読み取り / 書き込みリクエストとクローズ リクエストで使用されるリクエスト ID。

ProviderError

リクエストへのレスポンスで拡張機能を提供する場合や、API のメソッドを呼び出すときにエラーが発生した場合に使用されるエラーコード。成功するには、"OK" を使用する必要があります。

列挙型

[OK]

"FAILED"

"IN_USE"

"EXISTS"

"NOT_FOUND"

"ACCESS_DENIED"

"TOO_MANY_OPENED"

"NO_MEMORY"

"NO_SPACE"

"NOT_A_DIRECTORY"

"INVALID_OPERATION"

"SECURITY"

"ABORT"

"NOT_A_FILE"

"NOT_EMPTY"

"INVALID_URL"

「IO」

ReadDirectoryRequestedOptions

プロパティ

• directoryPath

  文字列

  コンテンツがリクエストされるディレクトリのパス。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• isDirectory

  ブール値

  Chrome 49 以降

  is_directory 値がリクエストされた場合は true に設定します。

• mimeType

  ブール値

  Chrome 49 以降

  mimeType 値がリクエストされた場合は true に設定します。

• modificationTime

  ブール値

  Chrome 49 以降

  modificationTime 値がリクエストされた場合は true に設定します。

• name

  ブール値

  Chrome 49 以降

  name 値がリクエストされた場合は true に設定します。

• requestId

  数値

  このリクエストの固有識別子。

• サイズ

  ブール値

  Chrome 49 以降

  size 値がリクエストされた場合は true に設定します。

• サムネイル

  ブール値

  Chrome 49 以降

  thumbnail 値がリクエストされた場合は true に設定します。

ReadFileRequestedOptions

プロパティ

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• 長さ

  数値

  返されるバイト数。

• offset

  数値

  読み取りを開始するファイル内の位置（バイト単位）。

• openRequestId

  数値

  ファイルを開くために使用されるリクエスト ID。

• requestId

  数値

  このリクエストの固有識別子。

RemoveWatcherRequestedOptions

プロパティ

• entryPath

  文字列

  モニタリング対象のエントリのパス。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• recursive

  ブール値

  ウォッチャーのモード。

• requestId

  数値

  このリクエストの固有識別子。

TruncateRequestedOptions

プロパティ

• filePath

  文字列

  切り捨てるファイルのパス。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• 長さ

  数値

  オペレーションの完了後に保持されるバイト数。

• requestId

  数値

  このリクエストの固有識別子。

UnmountOptions

プロパティ

• fileSystemId

  文字列

  マウントを解除するファイル システムの ID。

UnmountRequestedOptions

プロパティ

• fileSystemId

  文字列

  マウントを解除するファイル システムの ID。

• requestId

  数値

  このリクエストの固有識別子。

Watcher

プロパティ

• entryPath

  文字列

  モニタリング対象のエントリのパス。

• lastTag

  文字列 省略可

  ウォッチャーの最後の通知で使用されたタグ。

• recursive

  ブール値

  監視にすべての子エントリを再帰的に含めるかどうか。ディレクトリにのみ設定できます。

WriteFileRequestedOptions

プロパティ

• データ

  ArrayBuffer

  ファイルに書き込まれるバイトのバッファ。

• fileSystemId

  文字列

  このオペレーションに関連するファイル システムの ID。

• offset

  数値

  バイトの書き込みを開始するファイル内の位置（バイト単位）。

• openRequestId

  数値

  ファイルを開くために使用されるリクエスト ID。

• requestId

  数値

  このリクエストの固有識別子。

メソッド

get()

Promise

chrome.fileSystemProvider.get(
  fileSystemId: string,
  callback?: function,
): Promise<FileSystemInfo>

渡された fileSystemId を持つファイル システムに関する情報を返します。

パラメータ

• fileSystemId

  文字列

• callback

  function 省略可

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

  (fileSystem: FileSystemInfo) => void

  • fileSystem

    FileSystemInfo

戻り値

• Promise<FileSystemInfo>

  Chrome 96 以降

  get 関数の結果を受け取るコールバック。

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

getAll()

Promise

chrome.fileSystemProvider.getAll(
  callback?: function,
): Promise<FileSystemInfo[]>

拡張機能によってマウントされたすべてのファイル システムを返します。

パラメータ

• callback

  function 省略可

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

  (fileSystems: FileSystemInfo[]) => void

  • fileSystems

    FileSystemInfo[]

戻り値

• Promise<FileSystemInfo[]>

  Chrome 96 以降

  getAll 関数の結果を受け取るコールバック。

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

mount()

Promise

chrome.fileSystemProvider.mount(
  options: MountOptions,
  callback?: function,
): Promise<void>

指定された fileSystemId と displayName を使用してファイル システムをマウントします。displayName は、ファイルアプリの左側のパネルに表示されます。displayName には「/」を含む任意の文字を使用できますが、空の文字列にすることはできません。displayName は説明的なものにする必要がありますが、一意である必要はありません。fileSystemId を空の文字列にすることはできません。

マウントするファイル システムの種類に応じて、source オプションを適切に設定する必要があります。

エラーが発生した場合、runtime.lastError に対応するエラーコードが設定されます。

パラメータ

• オプション

  MountOptions

• callback

  function 省略可

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

  () => void

戻り値

• Promise<void>

  Chrome 96 以降

  成功または失敗を示す一般的な結果コールバック。

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

notify()

Promise Chrome 45 以降

chrome.fileSystemProvider.notify(
  options: NotifyOptions,
  callback?: function,
): Promise<void>

recursive モードで observedPath の監視対象ディレクトリの変更について通知します。ファイル システムが supportsNotifyTag でマウントされている場合は、tag を指定する必要があります。また、システムがシャットダウンされた場合でも、前回の通知以降のすべての変更が常に報告される必要があります。最後のタグは getAll で取得できます。

使用するには、file_system_provider.notify マニフェスト オプションを true に設定する必要があります。

tag の値は、呼び出しごとに一意の任意の文字列にできます。これにより、最後に登録された通知を識別できます。たとえば、提供元の拡張機能が再起動後に開始され、最後に登録された通知のタグが「123」と等しい場合、タグが「123」の変更以降に発生したすべての変更に対して notify を呼び出す必要があります。空の文字列にすることはできません。

すべてのプロバイダがタグを提供できるわけではありませんが、ファイル システムにチェンジログがある場合は、タグをチェンジ番号やリビジョン番号などにできます。

親ディレクトリが削除されると、すべての子孫エントリも削除されます。それらが監視されている場合は、その事実を API に通知する必要があります。また、ディレクトリの名前が変更されると、元のパスにエントリがなくなるため、すべての子孫エントリが実際に削除されます。

エラーが発生した場合、runtime.lastError に対応するエラーコードが設定されます。

パラメータ

• オプション

  NotifyOptions

• callback

  function 省略可

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

  () => void

戻り値

• Promise<void>

  Chrome 96 以降

  成功または失敗を示す一般的な結果コールバック。

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

unmount()

Promise

chrome.fileSystemProvider.unmount(
  options: UnmountOptions,
  callback?: function,
): Promise<void>

指定された fileSystemId を持つファイル システムのマウントを解除します。onUnmountRequested が呼び出された後に呼び出す必要があります。また、提供元の拡張機能は、リクエストされていない場合でも、マウント解除を実行することを決定できます（接続が失われた場合やファイルエラーが発生した場合など）。

エラーが発生した場合、runtime.lastError に対応するエラーコードが設定されます。

パラメータ

• オプション

  UnmountOptions

• callback

  function 省略可

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

  () => void

戻り値

• Promise<void>

  Chrome 96 以降

  成功または失敗を示す一般的な結果コールバック。

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

イベント

onAbortRequested

chrome.fileSystemProvider.onAbortRequested.addListener(
  callback: function,
)

operationRequestId を使用したオペレーションの中止がリクエストされたときに発生します。operationRequestId で実行されたオペレーションは直ちに停止し、この中止リクエストの successCallback を実行する必要があります。中止に失敗した場合は、errorCallback を呼び出す必要があります。中止されたオペレーションのコールバックは無視されるため、呼び出さないでください。errorCallback を呼び出しても、リクエストが強制的に中止されることがあります。

パラメータ

• callback

  関数

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

  (options: AbortRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    AbortRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onAddWatcherRequested

Chrome 45 以降

chrome.fileSystemProvider.onAddWatcherRequested.addListener(
  callback: function,
)

新しいディレクトリ ウォッチャーの設定がリクエストされたときに発生します。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: AddWatcherRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    AddWatcherRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onCloseFileRequested

chrome.fileSystemProvider.onCloseFileRequested.addListener(
  callback: function,
)

openRequestId で以前に開いたファイルを閉じるようにリクエストされたときに発生します。

パラメータ

• callback

  関数

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

  (options: CloseFileRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    CloseFileRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onConfigureRequested

Chrome 44 以降

chrome.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

fileSystemId の構成ダイアログの表示がリクエストされたときに発生します。処理される場合は、file_system_provider.configurable マニフェスト オプションを true に設定する必要があります。

パラメータ

• callback

  関数

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

  (options: ConfigureRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    ConfigureRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onCopyEntryRequested

chrome.fileSystemProvider.onCopyEntryRequested.addListener(
  callback: function,
)

エントリのコピー（ディレクトリの場合は再帰的）がリクエストされたときに発生します。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: CopyEntryRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    CopyEntryRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onCreateDirectoryRequested

chrome.fileSystemProvider.onCreateDirectoryRequested.addListener(
  callback: function,
)

ディレクトリの作成がリクエストされたときに発生します。ターゲット ディレクトリがすでに存在する場合、オペレーションは EXISTS エラーで失敗する必要があります。recursive が true の場合、ディレクトリ パスに存在しないディレクトリをすべて作成する必要があります。

パラメータ

• callback

  関数

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

  (options: CreateDirectoryRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    CreateDirectoryRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onCreateFileRequested

chrome.fileSystemProvider.onCreateFileRequested.addListener(
  callback: function,
)

ファイルの作成がリクエストされたときに発生します。ファイルがすでに存在する場合は、"EXISTS" エラーコードを指定して errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: CreateFileRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    CreateFileRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onDeleteEntryRequested

chrome.fileSystemProvider.onDeleteEntryRequested.addListener(
  callback: function,
)

エントリの削除がリクエストされたときに発生します。recursive が true で、エントリがディレクトリの場合、内部のすべてのエントリも再帰的に削除する必要があります。

パラメータ

• callback

  関数

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

  (options: DeleteEntryRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    DeleteEntryRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onExecuteActionRequested

Chrome 48 以降

chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

一連のファイルまたはディレクトリに対してアクションの実行がリクエストされたときに発生します。アクションが完了したら、successCallback を呼び出す必要があります。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: ExecuteActionRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    ExecuteActionRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onGetActionsRequested

Chrome 48 以降

chrome.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

entryPaths のファイルまたはディレクトリのセットに対するアクションのリストがリクエストされたときに発生します。返されるすべてのアクションは、各エントリに適用可能である必要があります。そのようなアクションがない場合は、空の配列を返す必要があります。アクションは successCallback 呼び出しで返す必要があります。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: GetActionsRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    GetActionsRequestedOptions

  • successCallback

    関数

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

    (actions: Action[]) => void

    • actions

      Action[]

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onGetMetadataRequested

chrome.fileSystemProvider.onGetMetadataRequested.addListener(
  callback: function,
)

entryPath のファイルまたはディレクトリのメタデータがリクエストされたときに発生します。メタデータは successCallback 呼び出しで返される必要があります。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: GetMetadataRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    GetMetadataRequestedOptions

  • successCallback

    関数

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

    (metadata: EntryMetadata) => void

    • metadata

      EntryMetadata

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onMountRequested

Chrome 44 以降

chrome.fileSystemProvider.onMountRequested.addListener(
  callback: function,
)

新しいファイル システムをマウントするためのダイアログの表示がリクエストされたときに発生します。拡張機能 / アプリがファイル ハンドラの場合、このイベントは処理されません。代わりに、ファイルが開かれたときに新しいファイル システムをマウントするために、app.runtime.onLaunched を処理する必要があります。複数のマウントの場合、file_system_provider.multiple_mounts マニフェスト オプションを true に設定する必要があります。

パラメータ

• callback

  関数

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

  (successCallback: function, errorCallback: function) => void

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onMoveEntryRequested

chrome.fileSystemProvider.onMoveEntryRequested.addListener(
  callback: function,
)

エントリの移動（ディレクトリの場合は再帰的）がリクエストされたときに発生します。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: MoveEntryRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    MoveEntryRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onOpenFileRequested

chrome.fileSystemProvider.onOpenFileRequested.addListener(
  callback: function,
)

filePath でファイルを開くようリクエストされたときに発生します。ファイルが存在しない場合、オペレーションは失敗します。一度に開くファイルの最大数は MountOptions で指定できます。

パラメータ

• callback

  関数

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

  (options: OpenFileRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    OpenFileRequestedOptions

  • successCallback

    関数

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

    (metadata?: EntryMetadata) => void

    • metadata

      EntryMetadata 省略可

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onReadDirectoryRequested

chrome.fileSystemProvider.onReadDirectoryRequested.addListener(
  callback: function,
)

directoryPath のディレクトリのコンテンツがリクエストされたときに発生します。結果は、successCallback を数回呼び出してチャンクで返す必要があります。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: ReadDirectoryRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    ReadDirectoryRequestedOptions

  • successCallback

    関数

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

    (entries: EntryMetadata[], hasMore: boolean) => void

    • entries

      EntryMetadata[]

    • hasMore

      ブール値

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onReadFileRequested

chrome.fileSystemProvider.onReadFileRequested.addListener(
  callback: function,
)

openRequestId で以前に開いたファイルの内容の読み取りがリクエストされたときに発生します。結果は、successCallback を複数回呼び出してチャンクで返す必要があります。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: ReadFileRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    ReadFileRequestedOptions

  • successCallback

    関数

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

    (data: ArrayBuffer, hasMore: boolean) => void

    • データ

      ArrayBuffer

    • hasMore

      ブール値

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onRemoveWatcherRequested

Chrome 45 以降

chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

ウォッチャーを削除する必要がある場合に発生します。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: RemoveWatcherRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    RemoveWatcherRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onTruncateRequested

chrome.fileSystemProvider.onTruncateRequested.addListener(
  callback: function,
)

ファイルを目的の長さに切り詰めることがリクエストされたときに発生します。エラーが発生した場合は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: TruncateRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    TruncateRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onUnmountRequested

chrome.fileSystemProvider.onUnmountRequested.addListener(
  callback: function,
)

fileSystemId 識別子を持つファイル システムのアンマウントがリクエストされたときに発生します。レスポンスでは、unmount API メソッドを successCallback とともに呼び出す必要があります。アンマウントできない場合（保留中のオペレーションがある場合など）は、errorCallback を呼び出す必要があります。

パラメータ

• callback

  関数

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

  (options: UnmountRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    UnmountRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError

onWriteFileRequested

chrome.fileSystemProvider.onWriteFileRequested.addListener(
  callback: function,
)

openRequestId で以前に開いたファイルにコンテンツを書き込むことがリクエストされたときに発生します。

パラメータ

• callback

  関数

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

  (options: WriteFileRequestedOptions, successCallback: function, errorCallback: function) => void

  • オプション

    WriteFileRequestedOptions

  • successCallback

    関数

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

    () => void

  • errorCallback

    関数

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

    (error: ProviderError) => void

    • エラー

      ProviderError