Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

downloads.cancel()

La fonction cancel() de l'API de downloads annule un téléchargement. L'appel échouera si le téléchargement n'est pas actif : par exemple, parce qu'il a terminé le téléchargement..

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

js
var canceling = browser.downloads.cancel(
  downloadId, // integer
);

Paramètres

downloadId

integer. L'identifiant du téléchargement à annuler.

Valeur retournée

Une Promise. Si la demande a été acceptée, la promesse sera remplie sans arguments. Si la demande a échoué, la promesse sera rejetée avec un message d'erreur.

Compatibilité des navigateurs

Exemples

js
var downloadId = 13;

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

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

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

Note :

Cette API est basée sur l'API Chromium chrome.downloads.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.