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.

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

Examples

function onPaused() {
  console.log(`Paused download`);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var pausing = browser.downloads.pause(downloadId);
pausing.then(onPaused, onError);