The pause() function of the downloads API pauses a download.
This is an asynchronous function that returns a Promise.
downloads.pause()
Syntax
let pausing = browser.downloads.pause(
downloadId // integer
)
Parameters
-
downloadId -
An
integerrepresenting theidof the download to pause.
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
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
pause |
Yes | 79 | 48 | ? | Yes | No | ? | ? | 48–79 | ? | No | ? |
Examples
function onPaused() {
console.log(`Paused download`);
}
function onError(error) {
console.log(`Error: ${error}`);
}
let pausing = browser.downloads.pause(downloadId);
pausing.then(onPaused, onError);
Note: This API is based on Chromium's chrome.downloads API.
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/downloads/pause