bookmarks

WebExtensions bookmarks API允许一个附加组件和浏览器的书签系统交互和操作。您可以用它给页面加书签,获取已有的书签,以及编辑,移除和管理书签。

欲使用此API,一个附件组件必须请求"bookmarks" permission在它的manifest.json文件当中。

类型

bookmarks.BookmarkTreeNode
表示在书签树中的一个书签或者文件夹。
bookmarks.BookmarkTreeNodeType (en-US)
一个描述在树中的一个节点是否是一个书签,一个文件夹或是一个分割符的 String 枚举类型。
bookmarks.BookmarkTreeNodeUnmodifiable (en-US)
一个说明了为什么一个书签或者文件夹是不可修改的 String 枚举类型。
bookmarks.CreateDetails (en-US)
当创建一个新书签时,包含被传递给这个 bookmarks.create() (en-US) 函数的信息。

方法

bookmarks.create() (en-US)
创建一个书签或文件夹。
bookmarks.get() (en-US)
获得一个或者多个BookmarkTreeNode,提供一个书签的编号或者一个书签编号的数组。
bookmarks.getChildren() (en-US)
获取指定BookmarkTreeNode节点的所有子节点。
bookmarks.getRecent() (en-US)
获取最近添加的几个书签。
bookmarks.getSubTree() (en-US)
获取从指定节点开始的部分书签树。
bookmarks.getTree()
获取整个书签树。
bookmarks.search() (en-US)
搜索书签树节点,找出匹配的结果。如果以对象方式指定查询,得到的 BookmarkTreeNodes 匹配所有指定的属性。
bookmarks.create() (en-US)
在指定的上一级文件夹下创建新的书签或文件夹。如果 url 为 null 或者省略,则创建文件夹。
bookmarks.move() (en-US)
将指定的书签树节点移到指定位置
bookmarks.update() (en-US)
更新书签或文件夹的属性。只需要指定您需要更改的属性,未指定的属性不会更改。注意:目前只支持“title”和“url”属性。
bookmarks.remove()
删除书签或者空文件夹。
bookmarks.removeTree() (en-US)
删除整个书签文件夹。
bookmarks.import()
从一个html书签文件导入书签
bookmarks.export()
导出书签为一个html书签文件

事件

bookmarks.onCreated (en-US)
当书签或文件夹创建时产生。
bookmarks.onRemoved (en-US)
当删除书签或文件夹时产生。当删除整个文件夹(包括其中所有内容)时,仅为该文件夹发送通知,不为其中任何内容发送通知。
bookmarks.onChanged (en-US)
一个书签或文件夹更改时发生。注意:目前只有标题和URL更改时会触发这一事件。
bookmarks.onMoved (en-US)
当书签或文件夹移动到另一个父文件夹中时产生。
bookmarks.onChildrenReordered (en-US)
文件夹中的子节点在用户界面中调整顺序时产生。调用 move() 不会触发该事件。
bookmarks.onImportBegan (en-US)
开始导入书签时产生。复杂的事件处理函数在这一事件产生后不应该再处理 onCreated 事件,直到 onImportEnded 事件产生,在此过程中其他事件仍然应该立即处理。
bookmarks.onImportEnded (en-US)
书签导入结束时产生。

浏览器兼容性

BCD tables only load in the browser

Example extensions

Acknowledgements

This API is based on Chromium's chrome.bookmarks API. This documentation is derived from bookmarks.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.