bookmarks.removeTree()

La méthode bookmarks.removeTree() supprime récursivement un dossier de signets et tout son contenu.

Attention : Si votre extension tente de supprimer une arborescence de signets du nœud racine de cette dernière, l'appel déclenche une erreur avec le message suivant: "La racine de signet ne peut pas être modifiée" et le signet ne sera pas supprimé.

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

js
var removingTree = browser.bookmarks.removeTree(
  id, // string
);

Paramètres

id

Un string spécifiant l'ID du noeud de dossier à supprimer avec ses descendants.

Valeur retournée

Une Promise qui sera remplie sans arguments lorsque l'arbre a été retiré.Si le noeud correspondant au paramètre id ne peut pas être trouvé, la promesse est rejetée avec un message d'erreur.

Exemples

Cet exemple localise un dossier de signets nommé "MDN" et le supprime avec tout son contenu.

js
function onRemoved() {
  console.log("bookmark item removed!");
}

function onRejected(error) {
  console.log(`An error: ${error}`);
}

function removeMDN(searchResults) {
  if (searchResults.length) {
    var removing = browser.bookmarks.removeTree(searchResults[0].id);
    removing.then(onRemoved, onRejected);
  }
}

var searchingBookmarks = browser.bookmarks.search({ title: "MDN" });
searchingBookmarks.then(removeMDN, onRejected);

Compatibilité des navigateurs

BCD tables only load in the browser

Note :

Cette API est basée sur l'API Chromium chrome.bookmarks. Cette documentation provient de bookmarks.json dans le code Chromium.

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.