downloads.pause()

downloads API 的 pause() 函式用於暫停下載。

這是一個非同步函式,返回一個 Promise

語法

js
let pausing = browser.downloads.pause(
  downloadId      // integer
)

引數

downloadId

一個代表要暫停下載的 idinteger

返回值

一個 Promise。如果呼叫成功,下載將被置於暫停狀態,並且 Promise 將在不帶引數的情況下被 fulfilled。如果呼叫失敗,Promise 將被 rejected 並帶有錯誤訊息。如果下載不是活動的(例如,因為它已經下載完成),呼叫將會失敗。

示例

js
function onPaused() {
  console.log(`Paused download`);
}

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

let pausing = browser.downloads.pause(downloadId);
pausing.then(onPaused, onError);

瀏覽器相容性

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