Searches for bookmarks matching the given query. Matching bookmarks are returned as bookmarks.BookmarkTreeNode objects.
Syntax
browser.bookmarks.search(
query, // string or object
function(results) {...} // function
)
Parameters
querystringobject- If
queryis a string, it consists of zero or more search terms. Search terms are space-delimited or may be quoted if the search term itself needs to include a space. Each search term matches if it matches any 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 match.
If
queryis an object, it has zero or more of the following 3 properties:query,title,url, which are described below. For a bookmark to match the query, all provided properties terms must match. -
queryOptionalstring. This matches in the same way as the string form ofquery.urlOptionalstring. This must exactly match the bookmark's url. Matching is case-insensitive, and trailing slashes are ignored.-
If you pass an invalid URL here, the function will throw an error.
titleOptionalstring. This must exactly match the bookmark's title. Matching is case-sensitive.
callbackfunction. The function is passed the following arguments:-
resultsarrayofbookmarks.BookmarkTreeNode
Browser compatibility
Examples
Example add-ons
Acknowledgements
This API is based on Chromium's chrome.bookmarks API. This documentation is derived from bookmarks.json in the Chromium code.
// 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.
