downloads.cancel()

Die cancel() Funktion der downloads API bricht einen Download ab. Der Aufruf schlägt fehl, wenn der Download nicht aktiv ist: zum Beispiel, weil er bereits abgeschlossen ist.

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

Syntax

js
let canceling = browser.downloads.cancel(
  downloadId      // integer
)

Parameter

downloadId

integer. Die ID des Downloads, der abgebrochen werden soll.

Rückgabewert

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

Browser-Kompatibilität

BCD tables only load in the browser

Beispiele

js
let downloadId = 13;

function onCanceled() {
  console.log(`Canceled download`);
}

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

let canceling = browser.downloads.cancel(downloadId);
canceling.then(onCanceled, onError);

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