bookmarks.getSubTree()
The bookmarks.getSubTree()
method asynchronously retrieves a bookmarks.BookmarkTreeNode
, given its ID.
If the item is a folder, you can access all its descendants recursively using its children
property and the children
property of its descendants, if they are themselves folders.
This is an asynchronous function that returns a Promise
.
Syntax
var gettingSubTree = browser.bookmarks.getSubTree(
id // string
)
Parameters
id
- A
string
specifying the ID of the root of the subtree to retrieve.
Return value
A Promise
that will be fulfilled with an array containing a single object, a bookmarks.BookmarkTreeNode
object, representing the item with the given ID.
If a node corresponding to id
could not be found, the promise will be rejected with an error message.
Examples
This example recursively prints out the subtree under a given node:
function makeIndent(indentLength) {
return ".".repeat(indentLength);
}
function logItems(bookmarkItem, indent) {
if (bookmarkItem.url) {
console.log(makeIndent(indent) + bookmarkItem.url);
} else {
console.log(makeIndent(indent) + "Folder: " + bookmarkItem.id);
indent++;
}
if (bookmarkItem.children) {
for (var child of bookmarkItem.children) {
logItems(child, indent);
}
}
}
function logSubTree(bookmarkItems) {
logItems(bookmarkItems[0], 0);
}
function onRejected(error) {
console.log(`An error: ${error}`);
}
var subTreeID = "root_____";
var gettingSubTree = browser.bookmarks.getSubTree(subTreeID);
gettingSubTree.then(logSubTree, onRejected);
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
getSubTree | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support45 | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
Legend
- Full support
- Full support
- No support
- No support
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.