downloads.search()

Die Funktion search() der downloads API durchsucht die im Download-Manager des Browsers verfügbaren DownloadItems 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 gegebenen Kriterien entsprechen.

Browser-Kompatibilität

Beispiele

Im Allgemeinen schränken Sie die abgerufenen Elemente mit dem query-Parameter ein.

Downloads abrufen, die mit "query" übereinstimmen

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 bestimmtes Element abrufen

Um ein bestimmtes DownloadItem abzurufen, ist der einfachste Weg, nur das id-Feld festzulegen, wie im folgenden Beispiel zu sehen:

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 aktuellsten Download abrufen

Sie können den aktuellsten 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 dieses Codebeispiel in unserem latest-download-Beispiel sehen.

Beispielerweiterungen

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