downloads

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 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 extension 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

Update compatibility data on GitHub
КомпьютерыМобильные
ChromeEdgeFirefoxOperaFirefox для Android
BooleanDeltaChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
DangerTypeChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
DoubleDeltaChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
DownloadQueryChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
DownloadTimeChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
FilenameConflictActionChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
InterruptReasonChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
StateChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
StringDeltaChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
acceptDangerChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Нет поддержки НетOpera Полная поддержка ДаFirefox Android Нет поддержки Нет
cancelChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48
downloadChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
dragChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Нет поддержки НетOpera Полная поддержка ДаFirefox Android Нет поддержки Нет
eraseChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48
getFileIconChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Нет поддержки Нет
onChangedChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
onCreatedChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48
onErasedChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48
openChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48
pauseChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48
removeFileChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48
resumeChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48
searchChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 47Opera Полная поддержка ДаFirefox Android Полная поддержка 48
setShelfEnabledChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Нет поддержки НетOpera Полная поддержка ДаFirefox Android Нет поддержки Нет
showChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48
showDefaultFolderChrome Полная поддержка ДаEdge Нет поддержки НетFirefox Полная поддержка 48Opera Полная поддержка ДаFirefox Android Полная поддержка 48

Легенда

Полная поддержка  
Полная поддержка
Нет поддержки  
Нет поддержки

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.