downloads

拡張機能にブラウザーのダウンロードマネージャーとのやりとりを可能にします。このAPI モジュールを、ファイルマネージャーでのファイルのダウンロード、キャンセル、停止、ダウンロードの再開、ダウンロード済みのファイルの表示に使用できます。

このAPIを使うには manifest.json ファイルで指定する "downloads" API パーミッションが必要です。

downloads.FilenameConflictAction (en-US)
ダウンロードされたファイル名が既存ファイルと衝突する場合の動作オプション定義
downloads.InterruptReason (en-US)
ダウンロードが中断された理由の集合を定義
downloads.DangerType (en-US)
ダウンロード可能なファイルに関連した想定される危険性への警告の集合を定義
downloads.State (en-US)
現在のダウンロードが取りうるさまざまな状態を定義
downloads.DownloadItem (en-US)
ダウンロード済みのファイルを表現する
downloads.StringDelta (en-US)
2つの文字列の差異を表現する
downloads.DoubleDelta (en-US)
2つの倍精度実数の差異を表現する
downloads.BooleanDelta (en-US)
2つの真偽値の差異を表現する
downloads.DownloadTime (en-US)
ダウンロード完了にかかった時間を表現する
downloads.DownloadQuery (en-US)
ダウンロードマネージャーで特定のダウンロードを検索するのに使われるパラメーターを定義

関数

downloads.download()
URL とオプション設定を与えて、ファイルをダウンロードします
downloads.search() (en-US)
ブラウザーのダウンロードマネージャーで使える DownloadItems (en-US) に問い合わせて、指定した検索条件にマッチするものを返します
downloads.pause() (en-US)
ダウンロードを停止します
downloads.resume() (en-US)
停止したダウンロードを再開します
downloads.cancel() (en-US)
ダウンロードをキャンセルします
downloads.getFileIcon() (en-US)
指定したダウンロードのアイコンを取得します
downloads.open() (en-US)
関連付けられたアプリケーションでダウンロード済みのファイルを開きます
downloads.show() (en-US)
プラットフォームのファイルマネージャーアプリケーションを開いて、ダウンロードフォルダー内のファイルを表示します
downloads.showDefaultFolder() (en-US)
プラットフォームのファイルマネージャーアプリケーションを開いて、デフォルトのダウンロードフォルダーを表示します
downloads.erase() (en-US)
ダウンロード済みのファイルをディスクから消去することなく、ブラウザーのダウンロード履歴からマッチした DownloadItems (en-US) を消去します
downloads.removeFile() (en-US)
ブラウザーのダウンロード履歴ではなく、ダウンロード済みのファイルをディスクから消去します
downloads.acceptDanger() (en-US)
危険なダウンロードを受け入れるかキャンセルするかを、ユーザーに確認します
downloads.drag() (en-US)
ダウンロード済みのファイルを他のアプリケーションにドラッグし始めます
downloads.setShelfEnabled() (en-US)
現在のブラウザープロファイルに関連するすぺてのウィンドウの下のグレーの棚を有効化/無効化します。この棚は少なくとも1つの拡張機能が無効化すると無効になります。

イベント

downloads.onCreated (en-US)
ダウンロード開始時に DownloadItem (en-US) オブジェクトと共に発火します
downloads.onErased (en-US)
ダウンロードが履歴から消去された時に downloadId と共に発火します
downloads.onChanged (en-US)
bytesReceived を除くいかなる DownloadItem (en-US) のプロパティが変わった時、このイベントは downloadId や変更したプロパティを含むオブジェクトと共に発火します

ブラウザ実装状況

BCD tables only load in the browser

Example extensions

謝辞

この API は Chromium の chrome.downloads API に基づいています。

Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。