downloads.cancel()

downloads API 的 cancel() 函数用于取消一个下载。如果下载未激活,则调用会失败:例如,因为它已完成下载。

这是一个异步函数,返回一个 Promise

语法

js
let canceling = browser.downloads.cancel(
  downloadId      // integer
)

参数

downloadId

integer。 要取消的下载的 ID。

返回值

一个 Promise。如果请求成功,Promise 将会无参数地 fulfilled。如果请求失败,Promise 将会附带一个错误消息被 rejected。

示例

js
let downloadId = 13;

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

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

let canceling = browser.downloads.cancel(downloadId);
canceling.then(onCanceled, onError);

浏览器兼容性

注意: 此 API 基于 Chromium 的 chrome.downloads API。