downloads.cancel()

downloads API 的 cancel() 函数用于取消一个下载操作。如果下载未处于活动状态(例如,已完成下载),则调用将失败。

这是一个返回 Promise 的异步函数。

语法

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

参数

downloadId

integer。要取消的下载的 id。

返回值

一个 Promise,如果请求成功其会兑现,且不带任何参数。如果请求失败,promise 将被拒绝并带有错误消息。

浏览器兼容性

BCD tables only load in the browser

示例

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。