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

downloadId
An integer representing the id of the download to pause.
function() {}Optional
An optional callback function. This function will be called once the pause call has been initiated or if it fails. It will be passed no 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

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 48.0 48.0 33

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.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, chrisdavidmills
 Last updated by: wbamberg,