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。