chrome.fileBrowserHandler

説明

権限

対象

Alt+Shift+M キーを押すか、SD カード、USB キー、外部ドライブ、デジタルカメラなどの外部ストレージ デバイスを接続すると、ChromeOS ファイル ブラウザが表示されます。ファイル ブラウザは、外部デバイスにあるファイルを表示するだけでなく、ユーザーが以前にシステムに保存したファイルを表示することもできます。

ユーザーが 1 つ以上のファイルを選択すると、ファイル ブラウザによって、それらのファイルの有効なハンドラを表すボタンが追加されます。たとえば、次のスクリーンショットでは、「.png」形式のファイルを選択しています。拡張子が「ギャラリーに保存」になりますユーザーがクリックできるボタンです。

マニフェスト

「fileBrowserHandler」を拡張機能のマニフェスト内で指定する必要があります。また、「file_browser_handlers」を使用してフィールドを使用して、少なくとも 1 つのファイル形式のハンドラとして拡張機能を登録します。ボタンに表示する 16x16 のアイコンも用意する必要があります。例:

{
  "name": "My extension",
  ...
  "file_browser_handlers": [
    {
      "id": "upload",
      "default_title": "Save to Gallery", // What the button will display
      "file_filters": [
        "filesystem:*.jpg",  // To match all files, use "filesystem:*.*"
        "filesystem:*.jpeg",
        "filesystem:*.png"
      ]
    }
  ],
  "permissions" : [
    "fileBrowserHandler"
  ],
  "icons": {
    "16": "icon16.png",
    "48": "icon48.png",
    "128": "icon128.png"
  },
  ...
}

ファイル ブラウザ ハンドラの実装

この API を使用するには、chrome.fileBrowserHandler の onExecute イベントを処理する関数を実装する必要があります。この関数は、ファイル ブラウザ ハンドラを表すボタンをクリックするたびに呼び出されます。関数で、File System API を使用してファイルの内容にアクセスします。以下に例を示します。

chrome.fileBrowserHandler.onExecute.addListener(async (id, details) => {
  if (id !== 'upload') {
    return;  // check if you have multiple file_browser_handlers
  }

  for (const entry of detail.entries) {
    // the FileSystemFileEntry doesn't have a Promise API, wrap in one
    const file = await new Promise((resolve, reject) => {
      entry.file(resolve, reject);
    });
    const buffer = await file.arrayBuffer();
    // do something with buffer
  }
});

イベント ハンドラには次の 2 つの引数が渡されます。

id

「id」値を指定する必要があります。拡張機能に複数のハンドラを実装している場合は、ID 値を確認することで、どのハンドラがトリガーされたかを確認できます。

詳細

イベントを記述するオブジェクト。ユーザーが選択したファイルは、このオブジェクトの entries フィールド（FileSystemFileEntry オブジェクトの配列）から取得できます。

chrome.fileBrowserHandler.onExecute.addListener(
  callback: function,
)