Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

downloads.cancel()

The cancel() function of the downloads API cancels a download.

The cancel() call will fail if the download is not active: for example, because it has completed downloading. You can check its download state using the downloads.DownloadItem state property, and the error will be available in runtime.lastError.

Syntax

chrome.downloads.cancel(
  downloadId,      // integer
  function() {...} // optional function
)

This API is also available as browser.downloads.cancel() in a version that returns a promise.

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.

Browser compatibility

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

Examples

The following snippet shows a button that when clicked invokes a downloads.download() call. Once the download starts, another button is given an event handler to cancel the download when clicked.

var downloadBtn = document.querySelector('#download');
var cancelBtn = document.querySelector('#cancel');

var url = 'https://example.org/file';

function onDownloadStarted(downloadId) {
  if(chrome.runtime.lastError) {
    console.log(chrome.runtime.lastError);
  } else {
    cancelBtn.onclick = function() {
      chrome.downloads.cancel(downloadId, onCanceled);
    }
  }
}

function onCanceled(i) {
  if (chrome.runtime.lastError) {
    console.log(chrome.runtime.lastError);
  } else {
    console.log('Download canceled');
  }
}

downloadBtn.onclick = function() {
  chrome.downloads.download({url}, onDownloadStarted);
}

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: Makyen, wbamberg, chrisdavidmills
 Last updated by: Makyen,