downloads

拡張機能にブラウザーのダウンロードマネージャーとのやりとりを可能にします。この 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 や変更したプロパティを含むオブジェクトと共に発火します

ブラウザーの互換性

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
downloads
BooleanDelta
DangerType
DoubleDelta
DownloadQuery
DownloadQuery.bytesReceived
DownloadQuery.cookieStoreId
DownloadQuery.danger
DownloadQuery.endTime
DownloadQuery.endedAfter
DownloadQuery.endedBefore
DownloadQuery.error
DownloadQuery.exists
DownloadQuery.fileSize
DownloadQuery.filename
DownloadQuery.filenameRegex
DownloadQuery.id
DownloadQuery.limit
DownloadQuery.mime
DownloadQuery.orderBy
DownloadQuery.paused
DownloadQuery.query
DownloadQuery.startTime
DownloadQuery.startedAfter
DownloadQuery.startedBefore
DownloadQuery.state
DownloadQuery.totalBytes
DownloadQuery.totalBytesGreater
DownloadQuery.totalBytesLess
DownloadQuery.url
DownloadQuery.urlRegex
DownloadTime
FilenameConflictAction
FilenameConflictAction.prompt
InterruptReason
State
StringDelta
acceptDanger
cancel
download
download.allowHttpErrors
download.body
download.conflictAction
download.cookieStoreId
download.filename
download.headers
download.incognito
download.method
download.saveAs
erase
getFileIcon
onChanged
onCreated
onErased
open
pause
removeFile
resume
search
setShelfEnabled
show
showDefaultFolder

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
No support
No support
See implementation notes.
Uses a non-standard name.
Has more compatibility info.

Example extensions

メモ: この API は Chromium の chrome.downloads API に基づいています。Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。