内容表

• 类型
• 函数
• 事件
• 浏览器兼容性
• Example extensions

bookmarks

WebExtensions bookmarks API lets an extension interact with and manipulate the browser's bookmarking system. You can use it to bookmark pages, retrieve existing bookmarks, and edit, remove, and organize bookmarks.

To use this API, an extension must request the "bookmarks" permission 在其 manifest.json 文件。

Extensions cannot create, modify, or delete bookmarks in the root node of the bookmarks tree. Doing so causes an error with the message: " The bookmark root cannot be modified "

类型

bookmarks.BookmarkTreeNode

Represents a bookmark or folder in the bookmarks tree.

bookmarks.BookmarkTreeNodeType

A 字符串 enum which describes whether a node in the tree is a bookmark, a folder, or a separator.

bookmarks.BookmarkTreeNodeUnmodifiable

A 字符串 enum which specifies why a bookmark or folder is unmodifiable.

bookmarks.CreateDetails

Contains information which is passed to the bookmarks.create() function when creating a new bookmark.

函数

bookmarks.create()

Creates a bookmark or folder.

bookmarks.get()

Retrieves one or more BookmarkTreeNode s, given a bookmark's ID or an array of bookmark IDs.

bookmarks.getChildren()

Retrieves the children of the specified BookmarkTreeNode .

bookmarks.getRecent()

Retrieves a requested number of recently added bookmarks.

bookmarks.getSubTree()

Retrieves part of the bookmarks tree, starting at the specified node.

bookmarks.getTree()

Retrieves the entire bookmarks tree into an array of BookmarkTreeNode 对象。

bookmarks.move()

Moves the specified BookmarkTreeNode to a new location in the bookmark tree.

bookmarks.remove()

Removes a bookmark or an empty bookmark folder, given the node's ID.

bookmarks.removeTree()

Recursively removes a bookmark folder; that is, given the ID of a folder node, removes that node and all its descendants.

bookmarks.search()

搜索 BookmarkTreeNode s matching a specified set of criteria.

bookmarks.update()

Updates the title and/or URL of a bookmark, or the name of a bookmark folder, given the bookmark's ID.

事件

bookmarks.onCreated

Fired when a bookmark or folder is created.

bookmarks.onRemoved

Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.

bookmarks.onChanged

Fired when a bookmark or folder changes. Currently, only title and url changes trigger this.

bookmarks.onMoved

Fired when a bookmark or folder is moved to a different parent folder or to a new offset within its folder.

bookmarks.onChildrenReordered

Fired when the user has sorted the children of a folder in the browser's UI. This is not called as a result of a move() .

bookmarks.onImportBegan

Fired when a bookmark import session is begun. Expensive observers should ignore bookmarks.onCreated updates until bookmarks.onImportEnded is fired. Observers should still handle other notifications immediately.

bookmarks.onImportEnded

Fired when a bookmark import session has finished.

浏览器兼容性

BCD tables only load in the browser

Example extensions

• bookmark-it

注意： 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.

Found a problem with this page?

• Edit on GitHub
• Source on GitHub
• Report a problem with this content on GitHub
• Want to fix the problem yourself? See our Contribution guide .

最后修改： Oct 26, 2021 , 由 MDN 贡献者

相关话题

1. 浏览器扩展名
2. 快速入门

   1. What are extensions?
   2. Your first extension
   3. Your second extension
   4. Anatomy of an extension
   5. Example extensions
   6. What next?
3. 概念

   1. Using the JavaScript APIs
   2. Content scripts
   3. Match patterns
   4. Working with files
   5. 国际化
   6. Content Security Policy
   7. Native messaging
   8. Differences between API implementations
   9. Chrome incompatibilities
4. 用户界面

   1. 用户界面
   2. Toolbar button
   3. Address bar button
   4. Sidebars
   5. Context menu items
   6. Options page
   7. Extension pages
   8. Notifications
   9. Address bar suggestions
   10. Developer tools panels
5. 如何

   1. Intercept HTTP requests
   2. Modify a web page
   3. Insert external content
   4. Share objects with page scripts
   5. Add a button to the toolbar
   6. Implement a settings page
   7. Work with the Tabs API
   8. Work with the Bookmarks API
   9. Work with the Cookies API
   10. Work with contextual identities
   11. Interact with the clipboard
   12. Build a cross-browser extension
6. Firefox differentiators
7. JavaScript API

   1. Browser support for JavaScript APIs
   2. alarms
   3. bookmarks
      1. 方法
         1. create()
         2. get()
         3. getChildren()
         4. getRecent()
         5. getSubTree()
         6. getTree()
         7. move()
         8. remove()
         9. removeTree()
         10. search()
         11. update()
      2. 特性
         1. BookmarkTreeNodeType
      3. 类型
         1. BookmarkTreeNode
         2. BookmarkTreeNodeUnmodifiable
         3. CreateDetails
      4. 事件
         1. onChanged
         2. onChildrenReordered
         3. onCreated
         4. onImportBegan
         5. onImportEnded
         6. onMoved
         7. onRemoved
   4. browserAction
   5. browserSettings
   6. browsingData
   7. captivePortal
   8. clipboard
   9. 命令
   10. contentScripts
   11. contextualIdentities
   12. Cookie
   13. devtools
   14. dns
   15. downloads
   16. events
   17. extension
   18. extensionTypes
   19. find
   20. history
   21. i18n
   22. identity
   23. idle
   24. management
   25. menus
   26. notifications
   27. omnibox
   28. pageAction
   29. permissions
   30. pkcs11
   31. privacy
   32. proxy
   33. runtime
   34. search
   35. sessions
   36. sidebarAction
   37. storage
   38. tabs
   39. theme
   40. topSites
   41. 类型
   42. userScripts
   43. webNavigation
   44. webRequest
   45. windows
8. Manifest keys

   1. 介绍

   1. 作者
   2. background
   3. browser_action
   4. browser_specific_settings
   5. chrome_settings_overrides
   6. chrome_url_overrides
   7. 命令
   8. content_scripts
   9. content_security_policy
   10. default_locale
   11. description
   12. developer
   13. devtools_page
   14. dictionaries
   15. externally_connectable
   16. homepage_url
   17. icons
   18. incognito
   19. manifest_version
   20. name
   21. offline_enabled
   22. omnibox
   23. optional_permissions
   24. options_page
   25. options_ui
   26. page_action
   27. permissions
   28. protocol_handlers
   29. short_name
   30. sidebar_action
   31. storage
   32. theme
   33. theme_experiment
   34. user_scripts
   35. version
   36. version_name
   37. web_accessible_resources
9. Extension Workshop

   1. Develop
   2. Publish
   3. Manage
   4. Enterprise
10. Contact us
11. Channels

    1. Add-ons blog
    2. Add-ons forum
    3. Add-ons chat