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
.
var canceling = browser.downloads.cancel( downloadId // integer )
downloadId
integer
. The id of the download to cancel.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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
cancel |
Yes |
79 |
48 |
? |
Yes |
No |
? |
? |
48-79 |
? |
? |
? |
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);
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.
© 2005–2021 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/cancel