downloads.pause()
The pause()
function of the downloads
API pauses a download.
This is an asynchronous function that returns a Promise
.
Syntax
let pausing = browser.downloads.pause(
downloadId // integer
)
Parameters
downloadId
-
An
integer
representing theid
of 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
BCD tables only load in the browser
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.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.