chrome.fileSystemProvider

説明

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

権限

fileSystemProvider

対象

<ph type="x-smartling-placeholder"></ph> ChromeOS のみ

マニフェスト

「fileSystemProvider」を権限と、拡張機能のマニフェストのセクション（File System Provider API を使用するための設定）例:

{
  "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 デバイスなど）からのファイル システムのコンテンツを提供するか、入力としてローカル ファイル（アーカイブなど）を使用します。

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

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

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

ファイル システムの構成

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

ライフサイクル

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

型

AbortRequestedOptions

プロパティ

  • fileSystemId

    文字列

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

  • operationRequestId

    数値

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

  • requestId

    数値

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

Action

Chrome 45 以降

プロパティ

  • id

    文字列

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

  • title

    文字列（省略可）

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

AddWatcherRequestedOptions

プロパティ

  • entryPath

    文字列

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

  • fileSystemId

    文字列

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

  • recursive

    ブール値

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

  • requestId

    数値

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

Change

プロパティ

  • changeType

    ChangeType

    エントリに加えられた変更の型。

  • cloudFileInfo

    CloudFileInfo（省略可）

    Chrome 125 以降

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

  • entryPath

    文字列

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

ChangeType

モニタリング対象のディレクトリで検出された変更のタイプ。

列挙型

変更済み

"DELETED"

CloseFileRequestedOptions

プロパティ

  • fileSystemId

    文字列

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

  • 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」

&quot;OFFLINE_NOT_NECESSARY&quot;

「共有」

ConfigureRequestedOptions

Chrome 44 以降

プロパティ

  • fileSystemId

    文字列

    構成するファイル システムの ID。

  • requestId

    数値

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

CopyEntryRequestedOptions

プロパティ

  • fileSystemId

    文字列

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

  • requestId

    数値

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

  • sourcePath

    文字列

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

  • targetPath

    文字列

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

CreateDirectoryRequestedOptions

プロパティ

  • directoryPath

    文字列

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

  • fileSystemId

    文字列

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

  • recursive

    ブール値

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

  • requestId

    数値

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

CreateFileRequestedOptions

プロパティ

  • filePath

    文字列

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

  • fileSystemId

    文字列

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

  • requestId

    数値

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

DeleteEntryRequestedOptions

プロパティ

  • entryPath

    文字列

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

  • fileSystemId

    文字列

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

  • recursive

    ブール値

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

  • requestId

    数値

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

EntryMetadata

プロパティ

  • cloudFileInfo

    CloudFileInfo（省略可）

    Chrome 125 以降

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

  • cloudIdentifier

    CloudIdentifier（省略可）

    Chrome 117 以降

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

  • isDirectory

    ブール値（省略可）

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

  • mimeType

    文字列（省略可）

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

  • modificationTime

    日付（省略可）

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

  • name

    文字列（省略可）

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

  • サイズ

    数値（省略可）

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

  • サムネイル

    文字列（省略可）

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

ExecuteActionRequestedOptions

Chrome 45 以降

プロパティ

  • actionId

    文字列

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

  • entryPaths

    string[]

    Chrome 47 以降

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

  • fileSystemId

    文字列

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

  • requestId

    数値

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

FileSystemInfo

プロパティ

  • displayName

    文字列

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

  • fileSystemId

    文字列

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

  • openedFiles

    OpenedFile[]

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

  • openedFilesLimit

    数値

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

  • supportsNotifyTag

    ブール値（省略可）

    Chrome 45 以降

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

  • Watchers

    視聴者[]

    Chrome 45 以降

    ウォッチャーのリスト。

  • 書き込み可能

    ブール値

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

GetActionsRequestedOptions

Chrome 45 以降

プロパティ

  • entryPaths

    string[]

    Chrome 47 以降

    アクションのリストに含まれるエントリのパスのリスト。

  • fileSystemId

    文字列

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

  • requestId

    数値

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

GetMetadataRequestedOptions

プロパティ

  • cloudFileInfo

    ブール値

    Chrome 125 以降

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

  • cloudIdentifier

    ブール値

    Chrome 117 以降

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

  • entryPath

    文字列

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

  • fileSystemId

    文字列

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

  • 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

    数値（省略可）

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

  • 永続

    ブール値（省略可）

    Chrome 64 以降

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

  • supportsNotifyTag

    ブール値（省略可）

    Chrome 45 以降

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

  • 書き込み可能

    ブール値（省略可）

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

MoveEntryRequestedOptions

プロパティ

  • fileSystemId

    文字列

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

  • requestId

    数値

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

  • sourcePath

    文字列

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

  • targetPath

    文字列

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

NotifyOptions

プロパティ

  • changeType

    ChangeType

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

  • 変更

    変更 [] オプション

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

  • fileSystemId

    文字列

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

  • observedPath

    文字列

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

  • recursive

    ブール値

    監視対象のエントリのモード。

  • タグ

    文字列（省略可）

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

OpenedFile

プロパティ

  • filePath

    文字列

    開かれたファイルのパス。

  • モード

    OpenFileMode

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

  • openRequestId

    数値

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

OpenFileMode

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

列挙型

読み取り

"書き込み"

OpenFileRequestedOptions

プロパティ

  • filePath

    文字列

    開くファイルのパス。

  • fileSystemId

    文字列

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

  • モード

    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"

セキュリティ

「中止」

"NOT_A_FILE"

NOT_EMPTY

"INVALID_URL"

「IO」

ReadDirectoryRequestedOptions

プロパティ

  • directoryPath

    文字列

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

  • fileSystemId

    文字列

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

  • 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

    文字列

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

  • 長さ

    数値

    返されるバイト数。

  • offset

    数値

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

  • openRequestId

    数値

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

  • requestId

    数値

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

RemoveWatcherRequestedOptions

プロパティ

  • entryPath

    文字列

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

  • fileSystemId

    文字列

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

  • recursive

    ブール値

    ウォッチャーのモード。

  • requestId

    数値

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

TruncateRequestedOptions

プロパティ

  • filePath

    文字列

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

  • fileSystemId

    文字列

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

  • 長さ

    数値

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

  • requestId

    数値

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

UnmountOptions

プロパティ

  • fileSystemId

    文字列

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

UnmountRequestedOptions

プロパティ

  • fileSystemId

    文字列

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

  • requestId

    数値

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

Watcher

プロパティ

  • entryPath

    文字列

    監視されているエントリのパス。

  • lastTag

    文字列（省略可）

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

  • recursive

    ブール値

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

WriteFileRequestedOptions

プロパティ

  • データ

    ArrayBuffer

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

  • fileSystemId

    文字列

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

  • offset

    数値

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

  • openRequestId

    数値

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

  • requestId

    数値

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

メソッド

get()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.fileSystemProvider.get(
  fileSystemId: string,
  callback?: function,
)

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

パラメータ

  • fileSystemId

    文字列

  • callback

    関数（省略可）

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

    (fileSystem: FileSystemInfo) => void

戻り値

  • Promise&lt;FileSystemInfo&gt;

    Chrome 96 以降

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

getAll()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.fileSystemProvider.getAll(
  callback?: function,
)

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

パラメータ

  • callback

    関数（省略可）

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

    (fileSystems: FileSystemInfo[]) => void

戻り値

  • Promise&lt;FileSystemInfo[]&gt;

    Chrome 96 以降

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

mount()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.fileSystemProvider.mount(
  options: MountOptions,
  callback?: function,
)

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

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

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

パラメータ

  • オプション

    MountOptions

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

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

notify()

<ph type="x-smartling-placeholder"></ph> 約束 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

戻り値

  • 約束 <void>

    Chrome 96 以降

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

unmount()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.fileSystemProvider.unmount(
  options: UnmountOptions,
  callback?: function,
)

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

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

パラメータ

  • オプション

    UnmountOptions

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <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

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 必須オプションを 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

    • successCallback

      関数

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

      () => void

    • errorCallback

      関数

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

      (error: ProviderError) => void

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

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 を呼び出す必要があります。

パラメータ

  • callback

    関数

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

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

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 を呼び出す必要があります。

パラメータ

  • callback

    関数

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

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

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

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