downloads.pause()
The pause
()
function of the downloads
API pauses a download.
This is an asynchronous function that returns a Promise
.
Syntax
var pausing = browser.downloads.pause(
downloadId // integer
)
Parameters
Return value
A Promise
. If the call was successful, the download will be put in a paused state, and the promise will be fulfilled with no arguments. If the call fails, the promise will be rejected with an error message. The call will fail if the download is not active: for example, because it has finished downloading.
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
pause | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support48 | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo support48 — 79 |
Legend
- Full support
- Full support
- No support
- No support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Examples
function onPaused() {
console.log(`Paused download`);
}
function onError(error) {
console.log(`Error: ${error}`);
}
var pausing = browser.downloads.pause(downloadId);
pausing.then(onPaused, onError);
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.