拡張機能にブラウザーのダウンロードマネージャーとのやりとりを可能にします。このAPI モジュールを、ファイルマネージャーでのファイルのダウンロード、キャンセル、停止、ダウンロードの再開、ダウンロード済みのファイルの表示に使用できます。
このAPIを使うには manifest.json ファイルで指定する "downloads" API パーミッションが必要です。
型
downloads.FilenameConflictAction
- ダウンロードされたファイル名が既存ファイルと衝突する場合の動作オプション定義
downloads.InterruptReason
- ダウンロードが中断された理由の集合を定義
downloads.DangerType
- ダウンロード可能なファイルに関連した想定される危険性への警告の集合を定義
downloads.State
- 現在のダウンロードが取りうるさまざまな状態を定義
downloads.DownloadItem
- ダウンロード済みのファイルを表現する
downloads.StringDelta
- 2つの文字列の差異を表現する
downloads.DoubleDelta
- 2つの倍精度実数の差異を表現する
downloads.BooleanDelta
- 2つの真偽値の差異を表現する
downloads.DownloadTime
- ダウンロード完了にかかった時間を表現する
downloads.DownloadQuery
- ダウンロードマネージャーで特定のダウンロードを検索するのに使われるパラメーターを定義
関数
downloads.download()
- URL とオプション設定を与えて、ファイルをダウンロードします
downloads.search()
- ブラウザーのダウンロードマネージャーで使える
DownloadItems
に問い合わせて、指定した検索条件にマッチするものを返します downloads.pause()
- ダウンロードを停止します
downloads.resume()
- 停止したダウンロードを再開します
downloads.cancel()
- ダウンロードをキャンセルします
downloads.getFileIcon()
- 指定したダウンロードのアイコンを取得します
downloads.open()
- 関連付けられたアプリケーションでダウンロード済みのファイルを開きます
downloads.show()
- プラットフォームのファイルマネージャーアプリケーションを開いて、ダウンロードフォルダー内のファイルを表示します
downloads.showDefaultFolder()
- プラットフォームのファイルマネージャーアプリケーションを開いて、デフォルトのダウンロードフォルダーを表示します
downloads.erase()
- ダウンロード済みのファイルをディスクから消去することなく、ブラウザーのダウンロード履歴からマッチした
DownloadItems
を消去します downloads.removeFile()
- ブラウザーのダウンロード履歴ではなく、ダウンロード済みのファイルをディスクから消去します
downloads.acceptDanger()
- 危険なダウンロードを受け入れるかキャンセルするかを、ユーザーに確認します
downloads.drag()
- ダウンロード済みのファイルを他のアプリケーションにドラッグし始めます
downloads.setShelfEnabled()
- 現在のブラウザープロファイルに関連するすぺてのウィンドウの下のグレーの棚を有効化/無効化します。この棚は少なくとも1つの拡張機能が無効化すると無効になります。
イベント
downloads.onCreated
- ダウンロード開始時に
DownloadItem
オブジェクトと共に発火します downloads.onErased
- ダウンロードが履歴から消去された時に
downloadId
と共に発火します downloads.onChanged
bytesReceived
を除くいかなるDownloadItem
のプロパティが変わった時、このイベントはdownloadId
や変更したプロパティを含むオブジェクトと共に発火します
ブラウザ実装状況
Update compatibility data on GitHub
デスクトップ | モバイル | ||||
---|---|---|---|---|---|
BooleanDelta | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
DangerType | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
DoubleDelta | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
DownloadQuery | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
DownloadTime | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
FilenameConflictAction | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
InterruptReason | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
State | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
StringDelta | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
acceptDanger | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 未対応 なし | Opera 完全対応 あり | Firefox Android 未対応 なし |
cancel | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
download | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
drag | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 未対応 なし | Opera 完全対応 あり | Firefox Android 未対応 なし |
erase | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
getFileIcon | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 未対応 なし |
onChanged | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
onCreated | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
onErased | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
open | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
pause | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
removeFile | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
resume | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
search | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 47 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
setShelfEnabled | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 未対応 なし | Opera 完全対応 あり | Firefox Android 未対応 なし |
show | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
showDefaultFolder | Chrome 完全対応 あり | Edge 未対応 なし | Firefox 完全対応 48 | Opera 完全対応 あり | Firefox Android 完全対応 48 |
凡例
- 完全対応
- 完全対応
- 未対応
- 未対応
Example extensions
謝辞
この API は Chromium の chrome.downloads
API に基づいています。
Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.