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。