downloads.removeFile()

Die Funktion removeFile() der downloads API entfernt eine heruntergeladene Datei von der Festplatte.

Diese API entfernt die Datei von der Festplatte, jedoch nicht aus der Download-Historie des Browsers. Daher wird ein Aufruf von downloads.search() das Element immer noch als DownloadItem zurückliefern, aber sein exists-Attribut wird false sein.

Um eine Datei aus der Download-Historie zu entfernen, müssen Sie downloads.erase() verwenden.

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

Hinweis: Wenn Sie eine heruntergeladene Datei sowohl von der Festplatte entfernen als auch aus der Historie löschen möchten, müssen Sie removeFile() vor downloads.erase() aufrufen. Wenn Sie es andersherum versuchen, erhalten Sie einen Fehler beim Aufruf von removeFile(), da der Browser keinen Eintrag des Downloads mehr hat.

Syntax

js
let removing = browser.downloads.removeFile(
  downloadId      // integer
)

Parameter

downloadId

Ein integer, der die ID des DownloadItem repräsentiert, das Sie von der Festplatte löschen möchten.

Rückgabewert

Ein Promise. Wenn die Anforderung erfolgreich war, wird das Promise ohne Argumente erfüllt. Wenn die Anforderung fehlschlug, wird das Promise mit einer Fehlermeldung abgelehnt.

Browser-Kompatibilität

BCD tables only load in the browser

Beispiele

Die zuletzt heruntergeladene Datei entfernen:

js
function onRemoved() {
  console.log(`Removed item`);
}

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

function remove(downloadItems) {
  if (downloadItems.length > 0) {
    let removing = browser.downloads.removeFile(downloadItems[0].id);
    removing.then(onRemoved, onError);
  }
}

let searching = browser.downloads.search({
  limit: 1,
  orderBy: ["-startTime"],
});

searching.then(remove, onError);

Beispielerweiterungen

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