chrome.fileSystemProvider

説明

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

権限

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（ブール値） - 省略可
複数（複数）のマウントされたファイル システムがサポートされているかどうか。デフォルトは false です。
watchable（ブール値） - 省略可
ウォッチャーの設定と変更に関する通知がサポートされているかどうか。デフォルトは false です。
source（「file」、「device」、「network」） - 必須
マウントされたファイル システムのデータのソース。

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

概要

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

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

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

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

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

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

ファイル システムの構成

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

ライフサイクル

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

型

AbortRequestedOptions

プロパティ

  • fileSystemId

    string

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

  • operationRequestId

    数値

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

  • requestId

    数値

    このリクエストの一意の識別子。

Action

Chrome 45 以降

プロパティ

  • id

    string

    アクションの ID。任意の文字列または CommonActionId（一般的なアクション）。

  • title

    string（省略可）

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

AddWatcherRequestedOptions

プロパティ

  • entryPath

    string

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

  • fileSystemId

    string

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

  • recursive

    boolean

    すべての子エントリを再帰的に含めるかどうか。これはディレクトリに対してのみ true になります。

  • requestId

    数値

    このリクエストの一意の識別子。

Change

プロパティ

  • changeType

    ChangeType

    エントリに適用された変更のタイプ。

  • cloudFileInfo

    CloudFileInfo 省略可

    保留中

    ファイルに関連する情報（クラウド ファイル システムを基盤としている場合）。

  • entryPath

    string

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

ChangeType

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

列挙型

CloseFileRequestedOptions

プロパティ

  • fileSystemId

    string

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

  • openRequestId

    数値

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

  • requestId

    数値

    このリクエストの一意の識別子。

CloudFileInfo

保留中

プロパティ

  • versionTag

    string（省略可）

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

CloudIdentifier

Chrome 117 以降

プロパティ

  • id

    string

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

  • providerName

    string

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

CommonActionId

Chrome 45 以降

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

列挙型

ConfigureRequestedOptions

Chrome 44 以降

プロパティ

  • fileSystemId

    string

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

  • requestId

    数値

    このリクエストの一意の識別子。

CopyEntryRequestedOptions

プロパティ

  • fileSystemId

    string

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

  • requestId

    数値

    このリクエストの一意の識別子。

  • sourcePath

    string

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

  • targetPath

    string

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

CreateDirectoryRequestedOptions

プロパティ

  • directoryPath

    string

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

  • fileSystemId

    string

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

  • recursive

    boolean

    操作が再帰的かどうか（ディレクトリの場合のみ）。

  • requestId

    数値

    このリクエストの一意の識別子。

CreateFileRequestedOptions

プロパティ

  • filePath

    string

    作成されるファイルのパス。

  • fileSystemId

    string

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

  • requestId

    数値

    このリクエストの一意の識別子。

DeleteEntryRequestedOptions

プロパティ

  • entryPath

    string

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

  • fileSystemId

    string

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

  • recursive

    boolean

    操作が再帰的かどうか（ディレクトリの場合のみ）。

  • requestId

    数値

    このリクエストの一意の識別子。

EntryMetadata

プロパティ

  • cloudFileInfo

    CloudFileInfo 省略可

    保留中

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

  • cloudIdentifier

    CloudIdentifier 省略可

    Chrome 117 以降

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

  • isDirectory

    ブール値（省略可）

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

  • mimeType

    string（省略可）

    エントリの MIME タイプ。常に任意ですが、options でリクエストする場合は指定する必要があります。

  • modificationTime

    日付（省略可）

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

  • name

    string（省略可）

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

  • サイズ

    number（省略可）

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

  • サムネイル

    string（省略可）

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

ExecuteActionRequestedOptions

Chrome 45 以降

プロパティ

  • actionId

    string

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

  • entryPaths

    string[]

    Chrome 47 以降

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

  • fileSystemId

    string

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

  • requestId

    数値

    このリクエストの一意の識別子。

FileSystemInfo

プロパティ

  • displayName

    string

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

  • fileSystemId

    string

    ファイル システムの識別子。

  • openedFiles

    OpenedFile[]

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

  • openedFilesLimit

    数値

    一度に開くことができるファイルの最大数。0 の場合、制限されません。

  • supportsNotifyTag

    ブール値（省略可）

    Chrome 45 以降

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

  • ウォッチャー

    ウォッチャー[]

    Chrome 45 以降

    ウォッチャーのリスト。

  • 書き込み可能

    boolean

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

GetActionsRequestedOptions

Chrome 45 以降

プロパティ

  • entryPaths

    string[]

    Chrome 47 以降

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

  • fileSystemId

    string

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

  • requestId

    数値

    このリクエストの一意の識別子。

GetMetadataRequestedOptions

プロパティ

  • cloudFileInfo

    boolean

    保留中

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

  • cloudIdentifier

    boolean

    Chrome 117 以降

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

  • entryPath

    string

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

  • fileSystemId

    string

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

  • isDirectory

    boolean

    Chrome 49 以降

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

  • mimeType

    boolean

    Chrome 49 以降

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

  • modificationTime

    boolean

    Chrome 49 以降

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

  • name

    boolean

    Chrome 49 以降

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

  • requestId

    数値

    このリクエストの一意の識別子。

  • サイズ

    boolean

    Chrome 49 以降

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

  • サムネイル

    boolean

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

MountOptions

プロパティ

  • displayName

    string

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

  • fileSystemId

    string

    ファイル システムの文字列識別子。広告表示オプションごとに一意である必要があります。

  • openedFilesLimit

    number（省略可）

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

  • 永続

    ブール値（省略可）

    Chrome 64 以降

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

  • supportsNotifyTag

    ブール値（省略可）

    Chrome 45 以降

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

  • 書き込み可能

    ブール値（省略可）

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

MoveEntryRequestedOptions

プロパティ

  • fileSystemId

    string

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

  • requestId

    数値

    このリクエストの一意の識別子。

  • sourcePath

    string

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

  • targetPath

    string

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

NotifyOptions

プロパティ

  • changeType

    ChangeType

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

  • 変更点

    Change[] （省略可）

    監視されたディレクトリ内のエントリの変更のリスト（エントリ自体を含む）

  • fileSystemId

    string

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

  • observedPath

    string

    観測されたエントリのパス。

  • recursive

    boolean

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

  • タグ

    string（省略可）

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

OpenedFile

プロパティ

  • filePath

    string

    開いているファイルのパス。

  • モード

    OpenFileMode

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

  • openRequestId

    数値

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

OpenFileMode

ファイルを開くモード。onOpenFileRequested によって使用されます。

列挙型

OpenFileRequestedOptions

プロパティ

  • filePath

    string

    開くファイルのパス。

  • fileSystemId

    string

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

  • モード

    OpenFileMode

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

  • requestId

    数値

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

ProviderError

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

列挙型

"NOT_FOUND"

"NOT_A_DIRECTORY"

"NOT_EMPTY"

ReadDirectoryRequestedOptions

プロパティ

  • directoryPath

    string

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

  • fileSystemId

    string

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

  • isDirectory

    boolean

    Chrome 49 以降

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

  • mimeType

    boolean

    Chrome 49 以降

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

  • modificationTime

    boolean

    Chrome 49 以降

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

  • name

    boolean

    Chrome 49 以降

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

  • requestId

    数値

    このリクエストの一意の識別子。

  • サイズ

    boolean

    Chrome 49 以降

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

  • サムネイル

    boolean

    Chrome 49 以降

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

ReadFileRequestedOptions

プロパティ

  • fileSystemId

    string

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

  • length

    数値

    返されるバイト数。

  • offset

    数値

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

  • openRequestId

    数値

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

  • requestId

    数値

    このリクエストの一意の識別子。

RemoveWatcherRequestedOptions

プロパティ

  • entryPath

    string

    監視対象エントリのパス。

  • fileSystemId

    string

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

  • recursive

    boolean

    ウォッチャーのモード。

  • requestId

    数値

    このリクエストの一意の識別子。

TruncateRequestedOptions

プロパティ

  • filePath

    string

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

  • fileSystemId

    string

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

  • length

    数値

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

  • requestId

    数値

    このリクエストの一意の識別子。

UnmountOptions

プロパティ

  • fileSystemId

    string

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

UnmountRequestedOptions

プロパティ

  • fileSystemId

    string

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

  • requestId

    数値

    このリクエストの一意の識別子。

Watcher

プロパティ

  • entryPath

    string

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

  • lastTag

    string（省略可）

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

  • recursive

    boolean

    すべての子エントリを再帰的に含めるかどうか。これはディレクトリに対してのみ true になります。

WriteFileRequestedOptions

プロパティ

  • data

    ArrayBuffer

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

  • fileSystemId

    string

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

  • offset

    数値

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

  • openRequestId

    数値

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

  • requestId

    数値

    このリクエストの一意の識別子。

Methods

get()

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

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

パラメータ

  • fileSystemId

    string

  • callback

    関数（省略可）

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

    (fileSystem: FileSystemInfo)=>void

戻り値

  • Promise<FileSystemInfo>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

getAll()

Promise 
chrome.fileSystemProvider.getAll(
  callback?: function,
)

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

パラメータ

  • callback

    関数（省略可）

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

    (fileSystems: FileSystemInfo[])=>void

戻り値

  • Promise<FileSystemInfo[]>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

mount()

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

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

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

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

パラメータ

  • オプション

    MountOptions

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

notify()

Promise Chrome 45 以降 
chrome.fileSystemProvider.notify(
  options: NotifyOptions,
  callback?: function,
)

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

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

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

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

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

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

パラメータ

  • オプション

    NotifyOptions

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

unmount()

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

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

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

パラメータ

  • オプション

    UnmountOptions

  • callback

    関数（省略可）

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

    ()=>void

戻り値

  • Promise<void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

イベント

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

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

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

onConfigureRequested

Chrome 44 以降 
chrome.fileSystemProvider.onConfigureRequested.addListener(
  callback: function,
)

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

パラメータ

  • callback

    機能

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

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

    • オプション

      ConfigureRequestedOptions

    • successCallback

      機能

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

      ()=>void

    • errorCallback

      機能

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

      (error: ProviderError)=>void

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

onCreateDirectoryRequested

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

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

パラメータ

  • callback

    機能

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

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

onCreateFileRequested

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

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

パラメータ

  • callback

    機能

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

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

    • オプション

      CreateFileRequestedOptions

    • successCallback

      機能

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

      ()=>void

    • errorCallback

      機能

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

      (error: ProviderError)=>void

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

onExecuteActionRequested

Chrome 48 以降 
chrome.fileSystemProvider.onExecuteActionRequested.addListener(
  callback: function,
)

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

パラメータ

  • callback

    機能

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

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

    • successCallback

      機能

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

      ()=>void

    • errorCallback

      機能

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

      (error: ProviderError)=>void

onGetActionsRequested

Chrome 48 以降 
chrome.fileSystemProvider.onGetActionsRequested.addListener(
  callback: function,
)

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

パラメータ

onGetMetadataRequested

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

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

パラメータ

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

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

onOpenFileRequested

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

filePath のファイルを開くことが要求されると発生します。ファイルが存在しない場合、オペレーションは失敗する必要があります。同時に開くファイルの最大数は MountOptions で指定できます。

パラメータ

  • callback

    機能

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

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

onReadDirectoryRequested

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

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

パラメータ

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

      • data

        ArrayBuffer

      • hasMore

        boolean

    • errorCallback

      機能

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

      (error: ProviderError)=>void

onRemoveWatcherRequested

Chrome 45 以降 
chrome.fileSystemProvider.onRemoveWatcherRequested.addListener(
  callback: function,
)

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

パラメータ

  • callback

    機能

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

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

    • successCallback

      機能

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

      ()=>void

    • errorCallback

      機能

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

      (error: ProviderError)=>void

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

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

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