Given the ID of a bookmarks.BookmarkTreeNode
or an array of such IDs, the bookmarks.get()
method retrieves the matching nodes and delivers them to a specified callback function.
Syntax
chrome.bookmarks.get( idOrIdList, // string or string array function( // function results // array ) {...} )
This API is also available as browser.bookmarks.get()
in a version that returns a promise.
Parameters
idOrIdList
Astring
string
orarray
of strings specifying the IDs of one or moreBookmarkTreeNode
objects to retrieve.callback
- A
function
to be called once the nodes have been retrieved. The function is passed the following parameters: -
results
- A
array
of matching nodes, in which each entry is abookmarks.BookmarkTreeNode
. Separators are not included in the results. If no nodes could be found,results
is undefined andruntime.lastError
is set.
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
Basic support | Yes | No | 45.0 | No | 33 |
Examples
This example checks to see if a bookmark with a particular ID exists:
function onGot(bookmarkItems) { if (bookmarkItems) { console.log("bookmark exists!"); } else { console.log("bookmark does not exist!"); console.log("lasterror: " + chrome.runtime.lastError); } } function doesBookmarkExist(bookmarkId) { chrome.bookmarks.get(bookmarkId, onGot); }
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.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.