downloads

Позволяет расширениям взаимодействовать с менеджером загрузки браузера. Этот модуль API можно использовать для загрузки, отмены, приостановки, возобновления загрузки файлов и отображения загруженных файлов в файловом менеджере.

Для использования этого API вам необходимо указать "downloads" API permission в вашем manifest.json файле.

Types

downloads.FilenameConflictAction
Определяет действия в случае, если имя загружаемого файла конфликтует с именем существующего файла.
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

BCD tables only load in the browser

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.