downloads.erase()

La fonction erase() de l'API downloads efface la correspondance DownloadItems de l'historique de téléchargement du navigateur sans supprimer les fichiers téléchargés du disque.

Pour supprimer les fichiers du disque, vous devez utiliser downloads.removeFile().

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 downloads.removeFile() before you call erase(). Si vous l'essayez dans l'autre sens, vous obtiendrez une erreur lors de l'appel de downloads.removeFile(), car il n'existe plus selon le navigateur.

Syntaxe

js
var erasing = browser.downloads.erase(
  query, // DownloadQuery
);

Paramètres

query

Un objet downloads.DownloadQuery.

Valeur retournée

Une Promise. Si l'appel a réussi, la promesse sera remplie avec un tableau d'entiers représentant les identifiants des DownloadItems effacés. Si aucun élément correspondant au paramètre de requête n'a pu être trouvé, le tableau sera vide. Si l'appel a échoué, la promesse sera rejetée avec un message d'erreur.

Compatibilité des navigateurs

BCD tables only load in the browser

Exemples

Effacer le téléchargement le plus récent :

js
function onErased(ids) {
  console.log(`Erased: ${ids}`);
}

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

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

erasing.then(onErased, onError);

Tout effacer :

js
function onErased(ids) {
  console.log(`Erased: ${ids}`);
}

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

var erasing = browser.downloads.erase({});
erasing.then(onErased, 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.