このページは Cloud Translation API によって翻訳されました。

chrome.fileBrowserHandler

説明

chrome.fileBrowserHandler API を使用して ChromeOS ファイルブラウザを拡張します。たとえば、この API を使用すると、ユーザーがウェブサイトにファイルをアップロードできるようになります。

コンセプトと使用方法

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

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

権限

fileBrowserHandler

拡張機能のマニフェストで "fileBrowserHandler" 権限を宣言する必要があります。

対象

ChromeOS のみフォアグラウンドのみ

拡張機能を少なくとも 1 つのファイル形式のハンドラとして登録するには、"file_browser_handlers" フィールドを使用する必要があります。また、ボタンに表示する 16 x 16 のアイコンを用意する必要があります。次に例を示します。

{
  "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 値をチェックして、トリガーされたハンドラを確認できます。
details: イベントを記述するオブジェクト。このオブジェクトの entries フィールド（FileSystemFileEntry オブジェクトの配列）から、ユーザーが選択したファイルを取得できます。

型

FileHandlerExecuteEventDetails

fileBrowserHandler.onExecute イベントのイベント詳細ペイロード。

プロパティ

entries

任意 []

このアクションの対象となるファイルを表す Entry インスタンスの配列（ChromeOS のファイルブラウザで選択）。
tab_id

number（省略可）

このイベントが発生したタブの ID。タブ ID はブラウザセッション内で一意です。

イベント

onExecute

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

ChromeOS のファイルブラウザからファイルシステムアクションが実行されると呼び出されます。

パラメータ

callback

機能

callback パラメータは次のようになります。
```
(id: string,details: FileHandlerExecuteEventDetails)=>void
```
- id
  
  文字列
- 詳細
  
  FileHandlerExecuteEventDetails