| Index: chrome/common/extensions/docs/bookmarks.html
|
| diff --git a/chrome/common/extensions/docs/bookmarks.html b/chrome/common/extensions/docs/bookmarks.html
|
| deleted file mode 100644
|
| index bb7f273546a30aa34db435524247b0e89671dd17..0000000000000000000000000000000000000000
|
| --- a/chrome/common/extensions/docs/bookmarks.html
|
| +++ /dev/null
|
| @@ -1,2725 +0,0 @@
|
| -<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
|
| - 1) The <head> information in this page is significant, should be uniform
|
| - across api docs and should be edited only with knowledge of the
|
| - templating mechanism.
|
| - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
|
| - browser, it will be re-generated from the template, json schema and
|
| - authored overview content.
|
| - 4) The <body>.innerHTML is also generated by an offline step so that this
|
| - page may easily be indexed by search engines.
|
| ---><html xmlns="http://www.w3.org/1999/xhtml"><head>
|
| - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
| - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
|
| - <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
|
| - <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">
|
| - </script>
|
| - <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">
|
| - </script>
|
| - <script type="text/javascript" src="js/api_page_generator.js"></script>
|
| - <script type="text/javascript" src="js/bootstrap.js"></script>
|
| - <script type="text/javascript" src="js/sidebar.js"></script>
|
| - <meta name="description" content="Documentation for the chrome.bookmarks module, which is part of the Google Chrome extension APIs."><title>Bookmarks - Google Chrome Extensions - Google Code</title></head>
|
| - <body> <div id="devModeWarning" class="displayModeWarning">
|
| - You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
|
| - </div>
|
| - <div id="branchWarning" class="displayModeWarning">
|
| - <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
|
| - It may not work with the stable release of Chrome.</span>
|
| - <select id="branchChooser">
|
| - <option>Choose a different version...
|
| - </option><option value="">Stable
|
| - </option><option value="beta">Beta
|
| - </option><option value="dev">Dev
|
| - </option><option value="trunk">Trunk
|
| - </option></select>
|
| - </div>
|
| - <div id="unofficialWarning" class="displayModeWarning">
|
| - <span>WARNING: This is unofficial documentation. It may not work with the
|
| - current release of Chrome.</span>
|
| - <button id="goToOfficialDocs">Go to the official docs</button>
|
| - </div>
|
| - <div id="gc-container" class="labs">
|
| - <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
|
| - <!-- In particular, sub-templates that recurse, must be used by allowing
|
| - jstemplate to make a copy of the template in this section which
|
| - are not operated on by way of the jsskip="true" -->
|
| - <!-- /SUBTEMPLATES -->
|
| - <a id="top"></a>
|
| - <div id="skipto">
|
| - <a href="#gc-pagecontent">Skip to page content</a>
|
| - <a href="#gc-toc">Skip to main navigation</a>
|
| - </div>
|
| - <!-- API HEADER -->
|
| - <table id="header" width="100%" cellspacing="0" border="0">
|
| - <tbody><tr>
|
| - <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>
|
| - <td valign="middle" width="100%" style="padding-left:0.6em;">
|
| - <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">
|
| - <div id="gsc-search-box">
|
| - <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
|
| - <input type="hidden" name="ie" value="UTF-8">
|
| - <input type="text" name="q" value="" size="55">
|
| - <input class="gsc-search-button" type="submit" name="sa" value="Search">
|
| - <br>
|
| - <span class="greytext">e.g. "page action" or "tabs"</span>
|
| - </div>
|
| - </form>
|
| - <script type="text/javascript" src="https://www.google.com/jsapi"></script>
|
| - <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
|
| - <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>
|
| - <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>
|
| - </td>
|
| - </tr>
|
| - </tbody></table>
|
| - <div id="codesiteContent" class="">
|
| - <a id="gc-topnav-anchor"></a>
|
| - <div id="gc-topnav">
|
| - <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>
|
| - <ul id="home" class="gc-topnav-tabs">
|
| - <li id="home_link">
|
| - <a href="index.html" title="Google Chrome Extensions home page">Home</a>
|
| - </li>
|
| - <li id="docs_link">
|
| - <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>
|
| - </li>
|
| - <li id="faq_link">
|
| - <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>
|
| - </li>
|
| - <li id="samples_link">
|
| - <a href="samples.html" title="Sample extensions (with source code)">Samples</a>
|
| - </li>
|
| - <li id="group_link">
|
| - <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>
|
| - </li>
|
| - <li id="so_link">
|
| - <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
|
| - </li>
|
| - </ul>
|
| - </div> <!-- end gc-topnav -->
|
| - <div class="g-section g-tpl-170">
|
| - <!-- SIDENAV -->
|
| - <div class="g-unit g-first" id="gc-toc">
|
| - <ul>
|
| - <li><a href="getstarted.html">Getting Started</a></li>
|
| - <li><a href="overview.html">Overview</a></li>
|
| - <li><a href="whats_new.html">What's New?</a></li>
|
| - <li><h2><a href="devguide.html">Developer's Guide</a></h2>
|
| - <ul>
|
| - <li>Browser UI
|
| - <ul>
|
| - <li><a href="browserAction.html">Browser Actions</a></li>
|
| - <li><a href="contextMenus.html">Context Menus</a></li>
|
| - <li><a href="notifications.html">Desktop Notifications</a></li>
|
| - <li><a href="omnibox.html">Omnibox</a></li>
|
| - <li><a href="options.html">Options Pages</a></li>
|
| - <li><a href="override.html">Override Pages</a></li>
|
| - <li><a href="pageAction.html">Page Actions</a></li>
|
| - </ul>
|
| - </li>
|
| - <li>Browser Interaction
|
| - <ul>
|
| - <li class="leftNavSelected">Bookmarks</li>
|
| - <li><a href="cookies.html">Cookies</a></li>
|
| - <li><a href="devtools.html">Developer Tools</a></li>
|
| - <li><a href="events.html">Events</a></li>
|
| - <li><a href="history.html">History</a></li>
|
| - <li><a href="management.html">Management</a></li>
|
| - <li><a href="tabs.html">Tabs</a></li>
|
| - <li><a href="windows.html">Windows</a></li>
|
| - </ul>
|
| - </li>
|
| - <li>Implementation
|
| - <ul>
|
| - <li><a href="a11y.html">Accessibility</a></li>
|
| - <li><a href="background_pages.html">Background Pages</a></li>
|
| - <li><a href="content_scripts.html">Content Scripts</a></li>
|
| - <li><a href="xhr.html">Cross-Origin XHR</a></li>
|
| - <li><a href="i18n.html">Internationalization</a></li>
|
| - <li><a href="messaging.html">Message Passing</a></li>
|
| - <li><a href="permissions.html">Optional Permissions</a></li>
|
| - <li><a href="npapi.html">NPAPI Plugins</a></li>
|
| - </ul>
|
| - </li>
|
| - <li>Finishing
|
| - <ul>
|
| - <li><a href="hosting.html">Hosting</a></li>
|
| - <li><a href="external_extensions.html">Other Deployment Options</a></li>
|
| - </ul>
|
| - </li>
|
| - </ul>
|
| - </li>
|
| - <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
|
| - <li><h2><a href="tutorials.html">Tutorials</a></h2>
|
| - <ul>
|
| - <li><a href="tut_debugging.html">Debugging</a></li>
|
| - <li><a href="tut_analytics.html">Google Analytics</a></li>
|
| - <li><a href="tut_oauth.html">OAuth</a></li>
|
| - </ul>
|
| - </li>
|
| - <li><h2>Reference</h2>
|
| - <ul>
|
| - <li>Formats
|
| - <ul>
|
| - <li><a href="manifest.html">Manifest Files</a></li>
|
| - <li><a href="match_patterns.html">Match Patterns</a></li>
|
| - </ul>
|
| - </li>
|
| - <li><a href="permission_warnings.html">Permission Warnings</a></li>
|
| - <li><a href="api_index.html">chrome.* APIs</a></li>
|
| - <li><a href="api_other.html">Other APIs</a></li>
|
| - </ul>
|
| - </li>
|
| - <li><h2><a href="samples.html">Samples</a></h2></li>
|
| - <div class="line"> </div>
|
| - <li><h2>More</h2>
|
| - <ul>
|
| - <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>
|
| - <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>
|
| - <li><a href="themes.html">Themes</a></li>
|
| - </ul>
|
| - </li>
|
| - </ul>
|
| - </div>
|
| - <script>
|
| - initToggles();
|
| - </script>
|
| - <div class="g-unit" id="gc-pagecontent">
|
| - <div id="pageTitle">
|
| - <h1 class="page_title">Bookmarks</h1>
|
| - </div>
|
| - <!-- TABLE OF CONTENTS -->
|
| - <div id="toc">
|
| - <h2>Contents</h2>
|
| - <ol>
|
| - <li>
|
| - <a href="#manifest">Manifest</a>
|
| - <ol>
|
| - </ol>
|
| - </li><li>
|
| - <a href="#description">Objects and properties</a>
|
| - <ol>
|
| - </ol>
|
| - </li><li>
|
| - <a href="#overview-examples">Examples</a>
|
| - <ol>
|
| - </ol>
|
| - </li>
|
| - <li>
|
| - <a href="#apiReference">API reference: chrome.bookmarks</a>
|
| - <ol>
|
| - <li>
|
| - <a href="#global-methods">Methods</a>
|
| - <ol>
|
| - <li>
|
| - <a href="#method-create">create</a>
|
| - </li><li>
|
| - <a href="#method-get">get</a>
|
| - </li><li>
|
| - <a href="#method-getChildren">getChildren</a>
|
| - </li><li>
|
| - <a href="#method-getRecent">getRecent</a>
|
| - </li><li>
|
| - <a href="#method-getSubTree">getSubTree</a>
|
| - </li><li>
|
| - <a href="#method-getTree">getTree</a>
|
| - </li><li>
|
| - <a href="#method-move">move</a>
|
| - </li><li>
|
| - <a href="#method-remove">remove</a>
|
| - </li><li>
|
| - <a href="#method-removeTree">removeTree</a>
|
| - </li><li>
|
| - <a href="#method-search">search</a>
|
| - </li><li>
|
| - <a href="#method-update">update</a>
|
| - </li>
|
| - </ol>
|
| - </li>
|
| - <li>
|
| - <a href="#global-events">Events</a>
|
| - <ol>
|
| - <li>
|
| - <a href="#event-onChanged">onChanged</a>
|
| - </li><li>
|
| - <a href="#event-onChildrenReordered">onChildrenReordered</a>
|
| - </li><li>
|
| - <a href="#event-onCreated">onCreated</a>
|
| - </li><li>
|
| - <a href="#event-onImportBegan">onImportBegan</a>
|
| - </li><li>
|
| - <a href="#event-onImportEnded">onImportEnded</a>
|
| - </li><li>
|
| - <a href="#event-onMoved">onMoved</a>
|
| - </li><li>
|
| - <a href="#event-onRemoved">onRemoved</a>
|
| - </li>
|
| - </ol>
|
| - </li>
|
| - <li>
|
| - <a href="#types">Types</a>
|
| - <ol>
|
| - <li>
|
| - <a href="#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - <ol>
|
| - </ol>
|
| - </li>
|
| - </ol>
|
| - </li>
|
| - </ol>
|
| - </li>
|
| - </ol>
|
| - </div>
|
| - <!-- /TABLE OF CONTENTS -->
|
| - <!-- Standard content lead-in for experimental API pages -->
|
| - <!-- STATIC CONTENT PLACEHOLDER -->
|
| - <div id="static"><div id="pageData-name" class="pageData">Bookmarks</div>
|
| -<!-- BEGIN AUTHORED CONTENT -->
|
| -<p id="classSummary">
|
| -Use the <code>chrome.bookmarks</code> module to create, organize,
|
| -and otherwise manipulate bookmarks.
|
| -Also see <a href="override.html">Override Pages</a>,
|
| -which you can use to create a custom Bookmark Manager page.
|
| -</p>
|
| -<img src="images/bookmarks.png" width="210" height="147" alt="Clicking the star adds a bookmark">
|
| -<h2 id="manifest">Manifest</h2>
|
| -<p>You must declare the "bookmarks" permission
|
| -in the <a href="manifest.html">extension manifest</a>
|
| -to use the bookmarks API.
|
| -For example:</p>
|
| -<pre>{
|
| - "name": "My extension",
|
| - ...
|
| - <b>"permissions": [
|
| - "bookmarks"
|
| - ]</b>,
|
| - ...
|
| -}</pre>
|
| -<h2 id="description">Objects and properties</h2>
|
| -<p>
|
| -Bookmarks are organized in a tree,
|
| -where each node in the tree
|
| -is either a bookmark or a folder
|
| -(sometimes called a <em>group</em>).
|
| -Each node in the tree
|
| -is represented by a
|
| -<a href="#type-BookmarkTreeNode"><code>BookmarkTreeNode</code></a> object.
|
| -</p>
|
| -<p>
|
| -<code>BookmarkTreeNode</code> properties
|
| -are used throughout the <code>chrome.bookmarks</code> API.
|
| -For example, when you call
|
| -<a href="#method-create"><code>create()</code></a>,
|
| -you pass in the new node's parent (<code>parentId</code>),
|
| -and, optionally, the node's
|
| -<code>index</code>, <code>title</code>, and <code>url</code> properties.
|
| -See <a href="#type-BookmarkTreeNode"><code>BookmarkTreeNode</code></a>
|
| -for information about the properties a node can have.
|
| -</p>
|
| -<p class="note"><b>Note:</b> You cannot use this API to add or remove entries
|
| -in the root folder. You also cannot rename, move, or remove the special
|
| -"Bookmarks Bar" and "Other Bookmarks" folders.</p>
|
| -<h2 id="overview-examples">Examples</h2>
|
| -<p>
|
| -The following code creates a folder with the title "Extension bookmarks".
|
| -The first argument to <code>create()</code> specifies properties
|
| -for the new folder.
|
| -The second argument defines a function
|
| -to be executed after the folder is created.
|
| -</p>
|
| -<pre>chrome.bookmarks.create({'parentId': bookmarkBar.id,
|
| - 'title': 'Extension bookmarks'},
|
| - function(newFolder) {
|
| - console.log("added folder: " + newFolder.title);
|
| -});
|
| -</pre>
|
| -<p>
|
| -The next snippet creates a bookmark pointing to
|
| -the developer documentation for extensions.
|
| -Since nothing bad will happen if creating the bookmark fails,
|
| -this code doesn't bother to define a callback function.
|
| -</p>
|
| -<pre>chrome.bookmarks.create({'parentId': extensionsFolderId,
|
| - 'title': 'Extensions doc',
|
| - 'url': 'http://code.google.com/chrome/extensions'});
|
| -</pre>
|
| -<p>
|
| -For an example of using this API, see the
|
| -<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/bookmarks/basic/">basic bookmarks sample</a>.
|
| -For other examples and for help in viewing the source code, see
|
| -<a href="samples.html">Samples</a>.
|
| -</p>
|
| -<!-- END AUTHORED CONTENT -->
|
| -</div>
|
| - <!-- API PAGE -->
|
| - <div class="apiPage">
|
| - <a name="apiReference"></a>
|
| - <h2>API reference: chrome.bookmarks</h2>
|
| - <!-- PROPERTIES -->
|
| - <!-- /apiGroup -->
|
| - <!-- METHODS -->
|
| - <div id="methodsTemplate" class="apiGroup">
|
| - <a name="global-methods"></a>
|
| - <h3>Methods</h3>
|
| - <!-- iterates over all functions -->
|
| - <div class="apiItem">
|
| - <a name="method-create"></a> <!-- method-anchor -->
|
| - <h4>create</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.create</span>(<span class="null"><span>object</span>
|
| - <var><span>bookmark</span></var></span><span class="optional"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Creates a bookmark or folder under the specified parentId. If url is NULL or missing, it will be a folder.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>bookmark</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>object</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <dd>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>parentId</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>Defaults to the Other Bookmarks folder.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>index</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>integer</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>title</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>url</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </dd>
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - If you specify the <em>callback</em> parameter, it should
|
| - specify a function that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span>BookmarkTreeNode result</span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>result</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-get"></a> <!-- method-anchor -->
|
| - <h4>get</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.get</span>(<span class="null"><span>string or array of string</span>
|
| - <var><span>idOrIdList</span></var></span><span class="null"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Retrieves the specified BookmarkTreeNode(s).</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>idOrIdList</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string or array of string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>A single string-valued id, or an array of string-valued ids</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - The <em>callback</em> parameter should specify a function
|
| - that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>results</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>
|
| - array of <span><span>
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-getChildren"></a> <!-- method-anchor -->
|
| - <h4>getChildren</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.getChildren</span>(<span class="null"><span>string</span>
|
| - <var><span>id</span></var></span><span class="null"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Retrieves the children of the specified BookmarkTreeNode id.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - The <em>callback</em> parameter should specify a function
|
| - that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>results</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>
|
| - array of <span><span>
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-getRecent"></a> <!-- method-anchor -->
|
| - <h4>getRecent</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.getRecent</span>(<span class="null"><span>integer</span>
|
| - <var><span>numberOfItems</span></var></span><span class="null"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Retrieves the recently added bookmarks.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>numberOfItems</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>integer</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>The maximum number of items to return.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - The <em>callback</em> parameter should specify a function
|
| - that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>results</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>
|
| - array of <span><span>
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-getSubTree"></a> <!-- method-anchor -->
|
| - <h4>getSubTree</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.getSubTree</span>(<span class="null"><span>string</span>
|
| - <var><span>id</span></var></span><span class="null"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Retrieves part of the Bookmarks hierarchy, starting at the specified node.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>The ID of the root of the subtree to retrieve.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - The <em>callback</em> parameter should specify a function
|
| - that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>results</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>
|
| - array of <span><span>
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-getTree"></a> <!-- method-anchor -->
|
| - <h4>getTree</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.getTree</span>(<span class="null"><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Retrieves the entire Bookmarks hierarchy.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - The <em>callback</em> parameter should specify a function
|
| - that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>results</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>
|
| - array of <span><span>
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-move"></a> <!-- method-anchor -->
|
| - <h4>move</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.move</span>(<span class="null"><span>string</span>
|
| - <var><span>id</span></var></span><span class="null"><span>, </span><span>object</span>
|
| - <var><span>destination</span></var></span><span class="optional"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Moves the specified BookmarkTreeNode to the provided location.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>destination</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>object</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <dd>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>parentId</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>index</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>integer</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </dd>
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - If you specify the <em>callback</em> parameter, it should
|
| - specify a function that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span>BookmarkTreeNode result</span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>result</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-remove"></a> <!-- method-anchor -->
|
| - <h4>remove</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.remove</span>(<span class="null"><span>string</span>
|
| - <var><span>id</span></var></span><span class="optional"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Removes a bookmark or an empty bookmark folder.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - If you specify the <em>callback</em> parameter, it should
|
| - specify a function that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-removeTree"></a> <!-- method-anchor -->
|
| - <h4>removeTree</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.removeTree</span>(<span class="null"><span>string</span>
|
| - <var><span>id</span></var></span><span class="optional"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Recursively removes a bookmark folder.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - If you specify the <em>callback</em> parameter, it should
|
| - specify a function that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-search"></a> <!-- method-anchor -->
|
| - <h4>search</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.search</span>(<span class="null"><span>string</span>
|
| - <var><span>query</span></var></span><span class="null"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Searches for BookmarkTreeNodes matching the given query.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>query</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - The <em>callback</em> parameter should specify a function
|
| - that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>results</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>
|
| - array of <span><span>
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="method-update"></a> <!-- method-anchor -->
|
| - <h4>update</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.bookmarks.update</span>(<span class="null"><span>string</span>
|
| - <var><span>id</span></var></span><span class="null"><span>, </span><span>object</span>
|
| - <var><span>changes</span></var></span><span class="optional"><span>, </span><span>function</span>
|
| - <var><span>callback</span></var></span>)</div>
|
| - <div class="description">
|
| - <p>Updates the properties of a bookmark or folder. Specify only the properties that you want to change; unspecified properties will be left unchanged. <b>Note:</b> Currently, only 'title' and 'url' are supported.</p>
|
| - <!-- PARAMETERS -->
|
| - <h4>Parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>changes</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>object</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <dd>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>title</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>url</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </dd>
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>callback</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>function</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - <!-- RETURNS -->
|
| - <dl>
|
| - </dl>
|
| - <!-- CALLBACK -->
|
| - <div>
|
| - <div>
|
| - <h4>Callback function</h4>
|
| - <p>
|
| - If you specify the <em>callback</em> parameter, it should
|
| - specify a function that looks like this:
|
| - </p>
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <pre>function(<span>BookmarkTreeNode result</span>) <span class="subdued">{...}</span>;</pre>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>result</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - </div>
|
| - <!-- MIN_VERSION -->
|
| - </div> <!-- /description -->
|
| - </div> <!-- /apiItem -->
|
| - </div> <!-- /apiGroup -->
|
| - <!-- EVENTS -->
|
| - <div id="eventsTemplate" class="apiGroup">
|
| - <a name="global-events"></a>
|
| - <h3>Events</h3>
|
| - <!-- iterates over all events -->
|
| - <div class="apiItem">
|
| - <a name="event-onChanged"></a>
|
| - <h4>onChanged</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.bookmarks.</span><span>onChanged</span><span class="subdued">.addListener</span>(function(<span>string id, object changeInfo</span>) <span class="subdued">{...}</span><span></span>);
|
| - </div>
|
| - <div class="description">
|
| - <p>Fired when a bookmark or folder changes. <b>Note:</b> Currently, only title and url changes trigger this.</p>
|
| - <!-- LISTENER PARAMETERS -->
|
| - <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>changeInfo</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>object</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <dd>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>title</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>url</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </dd>
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - <!-- EXTRA PARAMETERS -->
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <dl>
|
| - </dl>
|
| - </div> <!-- /description -->
|
| - <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="event-onChildrenReordered"></a>
|
| - <h4>onChildrenReordered</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.bookmarks.</span><span>onChildrenReordered</span><span class="subdued">.addListener</span>(function(<span>string id, object reorderInfo</span>) <span class="subdued">{...}</span><span></span>);
|
| - </div>
|
| - <div class="description">
|
| - <p>Fired when the children of a folder have changed their order due to the order being sorted in the UI. This is not called as a result of a move().</p>
|
| - <!-- LISTENER PARAMETERS -->
|
| - <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>reorderInfo</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>object</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <dd>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>childIds</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>
|
| - array of <span><span>
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </dd>
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - <!-- EXTRA PARAMETERS -->
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <dl>
|
| - </dl>
|
| - </div> <!-- /description -->
|
| - <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="event-onCreated"></a>
|
| - <h4>onCreated</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.bookmarks.</span><span>onCreated</span><span class="subdued">.addListener</span>(function(<span>string id, BookmarkTreeNode bookmark</span>) <span class="subdued">{...}</span><span></span>);
|
| - </div>
|
| - <div class="description">
|
| - <p>Fired when a bookmark or folder is created.</p>
|
| - <!-- LISTENER PARAMETERS -->
|
| - <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>bookmark</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - <!-- EXTRA PARAMETERS -->
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <dl>
|
| - </dl>
|
| - </div> <!-- /description -->
|
| - <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="event-onImportBegan"></a>
|
| - <h4>onImportBegan</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.bookmarks.</span><span>onImportBegan</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);
|
| - </div>
|
| - <div class="description">
|
| - <p>Fired when a bookmark import session is begun. Expensive observers should ignore handleCreated updates until onImportEnded is fired. Observers should still handle other notifications immediately.</p>
|
| - <!-- LISTENER PARAMETERS -->
|
| - <!-- EXTRA PARAMETERS -->
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <dl>
|
| - </dl>
|
| - </div> <!-- /description -->
|
| - <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="event-onImportEnded"></a>
|
| - <h4>onImportEnded</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.bookmarks.</span><span>onImportEnded</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);
|
| - </div>
|
| - <div class="description">
|
| - <p>Fired when a bookmark import session is ended.</p>
|
| - <!-- LISTENER PARAMETERS -->
|
| - <!-- EXTRA PARAMETERS -->
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <dl>
|
| - </dl>
|
| - </div> <!-- /description -->
|
| - <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="event-onMoved"></a>
|
| - <h4>onMoved</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.bookmarks.</span><span>onMoved</span><span class="subdued">.addListener</span>(function(<span>string id, object moveInfo</span>) <span class="subdued">{...}</span><span></span>);
|
| - </div>
|
| - <div class="description">
|
| - <p>Fired when a bookmark or folder is moved to a different parent folder.</p>
|
| - <!-- LISTENER PARAMETERS -->
|
| - <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>moveInfo</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>object</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <dd>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>parentId</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>index</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>integer</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>oldParentId</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>oldIndex</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>integer</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </dd>
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - <!-- EXTRA PARAMETERS -->
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <dl>
|
| - </dl>
|
| - </div> <!-- /description -->
|
| - <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="event-onRemoved"></a>
|
| - <h4>onRemoved</h4>
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.bookmarks.</span><span>onRemoved</span><span class="subdued">.addListener</span>(function(<span>string id, object removeInfo</span>) <span class="subdued">{...}</span><span></span>);
|
| - </div>
|
| - <div class="description">
|
| - <p>Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.</p>
|
| - <!-- LISTENER PARAMETERS -->
|
| - <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>removeInfo</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>object</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <dd>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>parentId</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>index</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>integer</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd class="todo">
|
| - Undocumented.
|
| - </dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </dd>
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| - <!-- EXTRA PARAMETERS -->
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <dl>
|
| - </dl>
|
| - </div> <!-- /description -->
|
| - <!-- /description -->
|
| - </div> <!-- /apiItem -->
|
| - </div> <!-- /apiGroup -->
|
| - <!-- TYPES -->
|
| - <div class="apiGroup">
|
| - <a name="types"></a>
|
| - <h3 id="types">Types</h3>
|
| - <!-- iterates over all types -->
|
| - <div class="apiItem">
|
| - <a name="type-BookmarkTreeNode"></a>
|
| - <h4>BookmarkTreeNode</h4>
|
| - <div>
|
| - <dt>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>object</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>A node (either a bookmark or a folder) in the bookmark tree. Child nodes are ordered within their parent folder.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <dd>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - <dt>
|
| - <var>id</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the browser is restarted.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>parentId</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>The <code>id</code> of the parent folder. Omitted for the root node.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>index</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>integer</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>The 0-based position of this node within its parent folder.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>url</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>The URL navigated to when a user clicks the bookmark. Omitted for folders.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>title</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>string</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>The text displayed for the node.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>dateAdded</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>number</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>When this node was created, in milliseconds since the epoch (<code>new Date(dateAdded)</code>).</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>dateGroupModified</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>number</span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>When the contents of this folder last changed, in milliseconds since the epoch.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>children</var>
|
| - <em>
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <span>
|
| - array of <span><span>
|
| - <span>
|
| - <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkTreeNode</a>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| - </em>
|
| - </dt>
|
| - <dd>An ordered list of children of this node.</dd>
|
| - <!-- OBJECT PROPERTIES -->
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div>
|
| - </dl>
|
| - </dd>
|
| - <!-- OBJECT METHODS -->
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <!-- FUNCTION PARAMETERS -->
|
| - </div>
|
| - </div> <!-- /apiItem -->
|
| - </div> <!-- /apiGroup -->
|
| - </div> <!-- /apiPage -->
|
| - </div> <!-- /gc-pagecontent -->
|
| - </div> <!-- /g-section -->
|
| - </div> <!-- /codesiteContent -->
|
| - <div id="gc-footer" --="">
|
| - <div class="text">
|
| - <p>
|
| - Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
|
| - the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
|
| - Attribution 3.0 License</a>, and code samples are licensed under the
|
| - <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
|
| - </p>
|
| - <p>
|
| - ©2011 Google
|
| - </p>
|
| -<!-- begin analytics -->
|
| -<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
|
| -<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>
|
| -<script type="text/javascript">
|
| - // chrome doc tracking
|
| - try {
|
| - var engdocs = _gat._getTracker("YT-10763712-2");
|
| - engdocs._trackPageview();
|
| - } catch(err) {}
|
| - // code.google.com site-wide tracking
|
| - try {
|
| - _uacct="UA-18071-1";
|
| - _uanchor=1;
|
| - _uff=0;
|
| - urchinTracker();
|
| - }
|
| - catch(e) {/* urchinTracker not available. */}
|
| -</script>
|
| -<!-- end analytics -->
|
| - </div>
|
| - </div> <!-- /gc-footer -->
|
| - </div> <!-- /gc-container -->
|
| -</body></html>
|
|
|