bookmarks.search()
function searches for bookmark tree nodes matching the given query.
This function throws an exception if any of the input parameters are invalid or are not of an appropriate type; look in the console for the error message. The exceptions don't have error IDs, and the messages themselves may change, so don't write code that tries to interpret them.
This is an asynchronous function that returns a
Promise
.
var searching = browser.bookmarks.search(
query
// string or object
)
query
A
string
or
对象
describing the query to perform.
若
query
是
string
, it consists of zero or more space-delimited search terms. Each search term matches if it is a substring in the bookmark's URL or title. Matching is case-insensitive. For a bookmark to match the query, all the query's search terms must be matched.
若
query
是
对象
, it consists of zero or more of 3 properties:
query
,
title
，和
url
, which are described below. For a bookmark to match the query, all the properties' terms must be matched.
query
可选
A
string
specifying one or more terms to match against; the format is identical to the string form of the
query
parameter. If this isn't a string, an exception is thrown.
url
可选
A
string
that must exactly match the bookmark's URL. Matching is case-insensitive, and trailing slashes are ignored.
If you pass an invalid URL, the function will throw an exception.
title
可选
A
string
that must exactly match the bookmark tree node's title. Matching is case-sensitive.
A
Promise
that will be fulfilled with an array of
bookmarks.BookmarkTreeNode
objects, each representing a single matching bookmark tree node. Results are returned in the order that the nodes were created. The array is empty if no results were found.
BookmarkTreeNodes
—even nodes of the
"folder"
type—returned by
bookmarks.search()
are missing the
children
property. To get a complete
BookmarkTreeNode
使用
bookmarks.getSubTree()
.
This example logs the IDs of all bookmarks:
function onFulfilled(bookmarkItems) {
for (item of bookmarkItems) {
console.log(item.id);
}
}
function onRejected(error) {
console.log(`An error: ${error}`);
}
var searching = browser.bookmarks.search({});
searching.then(onFulfilled, onRejected);
This example looks to see if the currently active tab is bookmarked:
function onFulfilled(bookmarkItems) {
if (bookmarkItems.length) {
console.log("active tab is bookmarked");
} else {
console.log("active tab is not bookmarked");
}
}
function onRejected(error) {
console.log(`An error: ${error}`);
}
function checkActiveTab(tab) {
var searching = browser.bookmarks.search({url: tab.url});
searching.then(onFulfilled, onRejected);
}
browser.browserAction.onClicked.addListener(checkActiveTab);
BCD tables only load in the browser
注意：
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.
最后修改： , 由 MDN 贡献者