downloads.search()

Die search() Funktion der downloads API fragt die im Download-Manager des Browsers verfügbaren DownloadItems ab und gibt diejenigen zurück, die den angegebenen Suchkriterien entsprechen.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Syntax

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

Parameter

query

Ein downloads.DownloadQuery Objekt.

Rückgabewert

Ein Promise. Das Promise wird mit einem array von downloads.DownloadItem Objekten erfüllt, die den angegebenen Kriterien entsprechen.

Browser-Kompatibilität

BCD tables only load in the browser

Beispiele

Im Allgemeinen beschränken Sie die abgerufenen Elemente unter Verwendung des query Parameters.

Downloads abrufen, die "query" entsprechen

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);

Ein spezifisches Element abrufen

Um einen bestimmten DownloadItem zu erhalten, ist es am einfachsten, nur das Feld id zu setzen, wie im folgenden Beispiel gezeigt:

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);

Alle Downloads abrufen

Wenn Sie alle DownloadItems zurückgeben möchten, setzen Sie query auf ein leeres Objekt.

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);

Den neuesten Download abrufen

Sie können den neuesten Download abrufen, indem Sie die folgenden Suchparameter angeben:

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);

Sie können diesen Code in unserem latest-download Beispiel in Aktion sehen.

Beispielerweiterungen

Hinweis: Diese API basiert auf der chrome.downloads API von Chromium.