W3cubDocs

/Web Extensions

bookmarks.get()

Given the ID of a bookmarks.BookmarkTreeNode or an array of such IDs, the bookmarks.get() method retrieves the matching nodes.

This is an asynchronous function that returns a Promise.

Syntax

var getBookmarks = browser.bookmarks.get(
  idOrIdList                // string or string array
)

Parameters

idOrIdList
string A string or array of strings specifying the IDs of one or more BookmarkTreeNode objects to retrieve.

Return value

A Promise that will be fulfilled with an array of BookmarkTreeNode, one for each matching node. Separators are not included in the results. If no nodes could be found, the promise will be rejected with an error message.

Examples

This example tries to get the bookmark whose ID is bookmarkAAAA. If no bookmark with this ID exists, onRejected is called:

function onFulfilled(bookmarks) {
  console.log(bookmarks);
}

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

var gettingBookmarks = browser.bookmarks.get("bookmarkAAAA");
gettingBookmarks.then(onFulfilled, onRejected);

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
get
Yes
79
45
?
Yes
No
?
?
No
?
?
?

Note: 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.

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/bookmarks/get