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

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

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);
}

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.