downloads

Enables WebExtensions 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 DownloadItems available 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 DownloadItems from 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 add-on has disabled it.

Events

downloads.onCreated
Fires with the DownloadItem object when a download begins.
downloads.onErased
Fires with the downloadId when a download is erased from history.
downloads.onChanged
When any of a DownloadItem's properties except bytesReceived changes, this event fires with the downloadId and an object containing the properties that changed.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
BooleanDelta Yes No 47.0 48.0 33
DangerType Yes No 47.0 48.0 33
DoubleDelta Yes No 47.0 48.0 33
DownloadItem Yes No 47.0 48.0 33
DownloadQuery Yes No 47.0 48.0 33
DownloadTime Yes No 47.0 48.0 33
FilenameConflictAction Yes No 47.0 * 48.0 * 33
InterruptReason Yes No 47.0 48.0 33
State Yes No 47.0 48.0 33
StringDelta Yes No 47.0 48.0 33
acceptDanger Yes No No No 33
cancel Yes No 48.0 48.0 33
download Yes No 47.0 * 48.0 33
drag Yes No No No 33
erase Yes No 48.0 48.0 33
getFileIcon Yes No No No 33
onChanged Yes No 47.0 48.0 33
onCreated Yes No 48.0 48.0 33
onErased Yes No 48.0 48.0 33
open Yes No 48.0 48.0 33
pause Yes No 48.0 48.0 33
removeFile Yes No 48.0 48.0 33
resume Yes No 48.0 48.0 33
search Yes No 47.0 48.0 33
setShelfEnabled Yes No No No 33
show Yes No 48.0 48.0 33
showDefaultFolder Yes No 48.0 48.0 33

Chrome incompatibilities

None.

Example add-ons

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.

Document Tags and Contributors

 Contributors to this page: wbamberg, chrisdavidmills
 Last updated by: wbamberg,