downloads.cancel()

The cancel() function of the downloads API cancels a download. The call will fail if the download is not active: for example, because it has completed downloading.

This is an asynchronous function that returns a Promise.

Syntax

var canceling = browser.downloads.cancel(
  downloadId      // integer
)

Parameters

downloadId
integer. The id of the download to cancel.
function() {}Optional
An optional callback function. This function will be called once the cancel call has been initiated or if it fails. It will be passed no parameters.

Return value

A Promise. If the request was successful, the promise will be fulfilled with no arguments. If the request failed, the promise will be rejected with an error message.

Browser compatibility

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

Examples

var downloadId = 13;

function onCanceled() {
  console.log(`Canceled download`);
}

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

var canceling = browser.downloads.cancel(downloadId);
canceling.then(onCanceled, 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,