Enables extensions to interact with the browser's download manager. You can use this API module to download files, cancel, pause, resume downloads, and show downloaded files in the file manager.
To use this API you need to have the "downloads" API permission specified in your manifest.json file.
Types
downloads.FilenameConflictAction- Defines options for what to do if the name of a downloaded file conflicts with an existing file.
downloads.InterruptReason- Defines a set of possible reasons why a download was interrupted.
downloads.DangerType- Defines a set of common warnings of possible dangers associated with downloadable files.
downloads.State- Defines different states that a current download can be in.
downloads.DownloadItem- Represents a downloaded file.
downloads.StringDelta- Represents the difference between two strings.
downloads.DoubleDelta- Represents the difference between two doubles.
downloads.BooleanDelta- Represents the difference between two booleans.
downloads.DownloadTime- Represents the time a download took to complete.
downloads.DownloadQuery- Defines a set of parameters that can be used to search the downloads manager for a specific set of downloads.
Functions
downloads.download()- Downloads a file, given its URL and other optional preferences.
downloads.search()- Queries the
DownloadItemsavailable in the browser's downloads manager, and returns those that match the specified search criteria. downloads.pause()- Pauses a download.
downloads.resume()- Resumes a paused download.
downloads.cancel()- Cancels a download.
downloads.getFileIcon()- Retrieves an icon for the specified download.
downloads.open()- Opens the downloaded file with its associated application.
downloads.show()- Opens the platform's file manager application to show the downloaded file in its containing folder.
downloads.showDefaultFolder()- Opens the platform's file manager application to show the default downloads folder.
downloads.erase()- Erases matching
DownloadItemsfrom the browser's download history, without deleting the downloaded files from disk. downloads.removeFile()- Removes a downloaded file from disk, but not from the browser's download history.
downloads.acceptDanger()- Prompts the user to accept or cancel a dangerous download.
downloads.drag()- Initiates dragging the downloaded file to another application.
downloads.setShelfEnabled()- Enables or disables the gray shelf at the bottom of every window associated with the current browser profile. The shelf will be disabled as long as at least one extension has disabled it.
Events
downloads.onCreated- Fires with the
DownloadItemobject when a download begins. downloads.onErased- Fires with the
downloadIdwhen a download is erased from history. downloads.onChanged- When any of a
DownloadItem's properties exceptbytesReceivedchanges, this event fires with thedownloadIdand an object containing the properties that changed.
Browser compatibility
| Chrome | Edge | Firefox | Firefox for Android | Opera | |
|---|---|---|---|---|---|
BooleanDelta | Yes | No | 47 | 48 | Yes |
DangerType | Yes | No | 47 | 48 | Yes |
DoubleDelta | Yes | No | 47 | 48 | Yes |
DownloadItem | Yes | No | 47 | 48 | Yes |
DownloadQuery | Yes | No | 47 | 48 | Yes |
DownloadTime | Yes | No | 47 | 48 | Yes |
FilenameConflictAction | Yes | No | 47 * | 48 * | Yes |
InterruptReason | Yes | No | 47 | 48 | Yes |
State | Yes | No | 47 | 48 | Yes |
StringDelta | Yes | No | 47 | 48 | Yes |
acceptDanger | Yes | No | No | No | Yes |
cancel | Yes | No | 48 | 48 | Yes |
download | Yes | No | 47 * | 48 * | Yes |
drag | Yes | No | No | No | Yes |
erase | Yes | No | 48 | 48 | Yes |
getFileIcon | Yes | No | No | No | Yes |
onChanged | Yes | No | 47 | 48 | Yes |
onCreated | Yes | No | 48 | 48 | Yes |
onErased | Yes | No | 48 | 48 | Yes |
open | Yes | No | 48 | 48 | Yes |
pause | Yes | No | 48 | 48 | Yes |
removeFile | Yes | No | 48 | 48 | Yes |
resume | Yes | No | 48 | 48 | Yes |
search | Yes | No | 47 | 48 | Yes |
setShelfEnabled | Yes | No | No | No | Yes |
show | Yes | No | 48 | 48 | Yes |
showDefaultFolder | Yes | No | 48 | 48 | Yes |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Chrome incompatibilities
None.
Example extensions
Acknowledgements
This API is based on Chromium's chrome.downloads API.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the 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.