bookmarks.removeTree()

bookmarks.removeTree() 方法递归删除一个书签文件夹及其所有内容。

警告: 如果你的扩展尝试从书签树根节点中删除书签树,则调用将引发错误,并显示消息:“The bookmark root cannot be modified”,并且书签将不会被删除。

这是一个返回 Promise 的异步函数。

语法

js
let removingTree = browser.bookmarks.removeTree(
  id                // 字符串
)

参数

id

字符串,指定要删除的文件夹(以及其后代节点)的 ID。

返回值

一个 Promise,当树被删除时其会兑现,且不带任何参数。

如果无法找到与 id 参数对应的节点,则该 Promise 将以错误消息拒绝。

示例

此示例查找名为“MDN”的书签文件夹,并删除它以及其中的所有内容。

js
function onRemoved() {
  console.log("书签项已删除!");
}

function onRejected(error) {
  console.log(`出现错误:${error}`);
}

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

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

浏览器兼容性

BCD tables only load in the browser

备注: 此 API 基于 Chromium 的 chrome.bookmarks API。该文档衍生自 Chromium 代码中的 bookmarks.json