bookmarks.update()
bookmarks.update()
updates the title and/or URL of a bookmark, or the name of a bookmark folder.
If your extension attempts to update a bookmark in the bookmarks tree root node, the call will raise an error with the message: "The bookmark root cannot be modified" and the bookmark won't be updated.
This is an asynchronous function that returns a Promise
.
Syntax
var updating = browser.bookmarks.update(
id, // string
changes // object
)
Parameters
Return value
A Promise
that will be fulfilled with a single bookmarks.BookmarkTreeNode
object, representing the updated bookmark. If the bookmark item corresponding to the id
parameter can't be found, the promise is rejected.
Examples
This example renames all folders named "MDN" to "Mozilla Developer Network (MDN)".
function onFulfilled(bookmarkItem) {
console.log(bookmarkItem.title);
}
function onRejected(error) {
console.log(`An error: ${error}`);
}
function updateFolders(items) {
for (item of items) {
// only folders, so skip items with a `url`
if (!item.url) {
var updating = browser.bookmarks.update(item.id, {
title: "Mozilla Developer Network (MDN)"
});
updating.then(onFulfilled, onRejected);
}
}
}
var searching = browser.bookmarks.search({ title: "MDN" });
searching.then(updateFolders, onRejected);
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
update | ChromeFull supportYes | EdgeFull support15 | 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.