downloads.search()

downloads API 的 search() 函数会查询浏览器下载管理器中可用的 DownloadItems,并返回与指定搜索条件匹配的项。

这是一个异步函数,返回一个 Promise

语法

js
let searching = browser.downloads.search(query);

参数

query

一个 downloads.DownloadQuery 对象。

返回值

一个 Promise。该 Promise 将会以一个匹配给定条件的 downloads.DownloadItem 对象数组的形式完成。

示例

通常,您会使用 query 参数来限制检索到的项。

获取匹配“query”的下载项

js
function logDownloads(downloads) {
  for (const download of downloads) {
    console.log(download.id);
    console.log(download.url);
  }
}

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

browser.downloads
  .search({
    query: ["imgur"],
  })
  .then(logDownloads, onError);

获取特定项

要获取特定的 DownloadItem,最简单的方法是只设置 id 字段,如下面的代码片段所示。

js
function logDownloads(downloads) {
  for (const download of downloads) {
    console.log(download.id);
    console.log(download.url);
  }
}

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

const id = 13;

browser.downloads.search({ id }).then(logDownloads, onError);

获取所有下载项

如果您想返回所有 DownloadItems,请将 query 设置为空对象。

js
function logDownloads(downloads) {
  for (const download of downloads) {
    console.log(download.id);
    console.log(download.url);
  }
}

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

browser.downloads.search({}).then(logDownloads, onError);

获取最新的下载项

您可以通过指定以下搜索参数来获取最新的下载项:

js
function logDownloads(downloads) {
  for (const download of downloads) {
    console.log(download.id);
    console.log(download.url);
  }
}

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

browser.downloads
  .search({
    limit: 1,
    orderBy: ["-startTime"],
  })
  .then(logDownloads, onError);

您可以在我们的 latest-download 示例中看到此代码的实际应用。

扩展程序示例

浏览器兼容性

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