downloads.pause()

The pause() function of the downloads API pauses a download.

这是一个异步函数，返回一个 Promise.

语法

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

参数

downloadId

一个代表要暂停下载的 id 的 integer。

返回值

一个 Promise。如果调用成功，下载将处于暂停状态，并且 promise 将在没有参数的情况下完成。如果调用失败，promise 将被拒绝并显示错误消息。如果下载未处于活动状态，则调用将失败：例如，因为它已完成下载。

浏览器兼容性

BCD 表格仅在浏览器中加载

示例

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。