downloads.download()

この翻訳は不完全です。英語から この記事を翻訳 してください。

downloads API の download() 関数ではURLとそのほかのオプションの設定を行うことでファイルのダウンロードをすることができます。

  • HTTPもしくはHTTPSのプロトコルを使用したURLを指定した場合、対象のホスト名に対応する全てのcookieを含んだリクエストが送られます。
  • filename と saveAs が指定されている場合、指定されたfilenameが設定された[名前をつけて保存]のダイアログが開きます。

この関数は非同期に実行され、Promiseを返します。

構文

var downloading = browser.downloads.download(
  options                   // object
)

パラメータ

options
このobjectではダウンロードしたいファイルやその他のダウンロードに関する設定を指定します。指定できるプロパティは以下です。
bodyOptional
リクエストのbodyをstringで指定します。
conflictActionOptional
A string representing the action you want taken if there is a filename conflict, as defined in the downloads.FilenameConflictAction type (defaults to "uniquify" when it is not specified).
filenameOptional
A string representing a file path relative to the default downloads directory — this provides the location where you want the file to be saved, and what filename you want to use. Absolute paths, empty paths, and paths containing back-references (../) will cause an error. If omitted, this value will default to the filename already given to the download file, and a location immediately inside the downloads directory.
headersOptional
An array of objects representing extra HTTP headers to send with the request if the URL uses the HTTP[s] protocol. Each header is represented as a dictionary object containing the keys name and either value or binaryValue, restricted to those allowed by XMLHttpRequest.
incognitoOptional
A boolean: if present and set to true, then associate this download with a private browsing session. This means that it will only appear in the download manager for any private windows that are currently open.
methodOptional
HTTP[S]を使用したURLを指定した際、HTTPメソッドをstringで指定します。GETもしくはPOSTを設定できます。
saveAsOptional

A boolean that specifies whether to provide a file chooser dialog to allow the user to select a filename (true), or not (false).

If this option is omitted, the browser will show the file chooser or not based on the general user preference for this behavior (in Firefox this preference is labeled "Always ask you where to save files" in about:preferences, or browser.download.useDownloadDir in about:config).

url
ダウンロードするURLをstringで指定します。

戻り値

Promiseが返却されます。ダウンロードが成功した場合、new downloads.DownloadItemのidが格納されたpromiseを受け取ります。対して、promiseがrejectされた場合は、エラーメッセージを受け取ります。

ブラウザ実装状況

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxOperaAndroid 版 Firefox
基本対応Chrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 47Opera 完全対応 ありFirefox Android 完全対応 48
bodyChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 52Opera 完全対応 ありFirefox Android 完全対応 52
conflictActionChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 47Opera 完全対応 ありFirefox Android 完全対応 48
filenameChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 47Opera 完全対応 ありFirefox Android 完全対応 48
headersChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 47Opera 完全対応 ありFirefox Android 完全対応 48
incognitoChrome 未対応 なしEdge 未対応 なしFirefox 完全対応 57Opera 未対応 なしFirefox Android 完全対応 57
methodChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 47
補足
完全対応 47
補足
補足 POST is supported from version 52.
Opera 完全対応 ありFirefox Android 完全対応 48
補足
完全対応 48
補足
補足 POST is supported from version 52.
saveAsChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 52
補足
完全対応 52
補足
補足 Before version 58, if this option was omitted, Firefox would never show the file chooser, regardless of the value of the browser's preference.
Opera 完全対応 ありFirefox Android 完全対応 52
補足
完全対応 52
補足
補足 Before version 58, if this option was omitted, Firefox would never show the file chooser, regardless of the value of the browser's preference.

凡例

完全対応  
完全対応
未対応  
未対応
実装ノートを参照してください。
実装ノートを参照してください。

以下のダウンロードの例ではファイル名と保存場所を指定し、conflictActionuniquifyを指定しています。

function onStartedDownload(id) {
  console.log(`Started downloading: ${id}`);
}

function onFailed(error) {
  console.log(`Download failed: ${error}`);
}

var downloadUrl = "https://example.org/image.png";

var downloading = browser.downloads.download({
  url : downloadUrl,
  filename : 'my-image-again.png',
  conflictAction : 'uniquify'
});

downloading.then(onStartedDownload, onFailed);

Acknowledgements

このAPIはChromiumの chrome.downloads APIを元にしています。

ドキュメントのタグと貢献者

このページの貢献者: mk-tool
最終更新者: mk-tool,