downloads.removeFile()

La fonction removeFile() de l'API downloads supprime un fichier téléchargé du disque.

Cette API supprime le fichier du disque, mais ne le supprime pas de l'historique des téléchargements du navigateur, donc un appel downloads.search() renvoie toujours l'élément comme DownloadItem, mais son attribut exists sera false.

Pour supprimer un fichier de l'historique des téléchargements, vous devez utiliser downloads.erase().

C'est une fonction asynchrone qui renvoie une Promise.

Note : Si vous souhaitez supprimer un fichier téléchargé du disque et l'effacer de l'historique, vous devez appeler removeFile() avant d'appeler downloads.erase(). Si vous l'essayez dans l'autre sens, vous obtiendrez une erreur lors de l'appel de removeFile(), car le navigateur n'aura plus d'enregistrement du téléchargement.

Syntaxe

js
var removing = browser.downloads.removeFile(
  downloadId, // integer
);

Paramètres

downloadId

Un integer représentant l'identifiant de DownloadItem que vous souhaitez supprimer du disque.

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

BCD tables only load in the browser

Exemples

Supprimer le dernier fichier téléchargé :

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

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

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

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

searching.then(remove, onError);

Example extensions

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.