Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(466)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/bookmarks.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/background_pages.html ('k') | chrome/common/extensions/docs/browserAction.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <meta name="description" content="Documentation for the chrome.bookmarks modul e, which is part of the Google Chrome extension APIs."><title>Bookmarks - Googl e Chrome Extensions - Google Code</title></head>
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li class="leftNavSelected">Bookmarks</li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">Bookmarks</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#manifest">Manifest</a>
196 <ol>
197 </ol>
198 </li><li>
199 <a href="#description">Objects and properties</a>
200 <ol>
201 </ol>
202 </li><li>
203 <a href="#overview-examples">Examples</a>
204 <ol>
205 </ol>
206 </li>
207 <li>
208 <a href="#apiReference">API reference: chrome.bookmarks</a>
209 <ol>
210 <li>
211 <a href="#global-methods">Methods</a>
212 <ol>
213 <li>
214 <a href="#method-create">create</a>
215 </li><li>
216 <a href="#method-get">get</a>
217 </li><li>
218 <a href="#method-getChildren">getChildren</a>
219 </li><li>
220 <a href="#method-getRecent">getRecent</a>
221 </li><li>
222 <a href="#method-getSubTree">getSubTree</a>
223 </li><li>
224 <a href="#method-getTree">getTree</a>
225 </li><li>
226 <a href="#method-move">move</a>
227 </li><li>
228 <a href="#method-remove">remove</a>
229 </li><li>
230 <a href="#method-removeTree">removeTree</a>
231 </li><li>
232 <a href="#method-search">search</a>
233 </li><li>
234 <a href="#method-update">update</a>
235 </li>
236 </ol>
237 </li>
238 <li>
239 <a href="#global-events">Events</a>
240 <ol>
241 <li>
242 <a href="#event-onChanged">onChanged</a>
243 </li><li>
244 <a href="#event-onChildrenReordered">onChildrenReordered</a>
245 </li><li>
246 <a href="#event-onCreated">onCreated</a>
247 </li><li>
248 <a href="#event-onImportBegan">onImportBegan</a>
249 </li><li>
250 <a href="#event-onImportEnded">onImportEnded</a>
251 </li><li>
252 <a href="#event-onMoved">onMoved</a>
253 </li><li>
254 <a href="#event-onRemoved">onRemoved</a>
255 </li>
256 </ol>
257 </li>
258 <li>
259 <a href="#types">Types</a>
260 <ol>
261 <li>
262 <a href="#type-BookmarkTreeNode">BookmarkTreeNode</a>
263 <ol>
264 </ol>
265 </li>
266 </ol>
267 </li>
268 </ol>
269 </li>
270 </ol>
271 </div>
272 <!-- /TABLE OF CONTENTS -->
273 <!-- Standard content lead-in for experimental API pages -->
274 <!-- STATIC CONTENT PLACEHOLDER -->
275 <div id="static"><div id="pageData-name" class="pageData">Bookmarks</div >
276 <!-- BEGIN AUTHORED CONTENT -->
277 <p id="classSummary">
278 Use the <code>chrome.bookmarks</code> module to create, organize,
279 and otherwise manipulate bookmarks.
280 Also see <a href="override.html">Override Pages</a>,
281 which you can use to create a custom Bookmark Manager page.
282 </p>
283 <img src="images/bookmarks.png" width="210" height="147" alt="Clicking the star adds a bookmark">
284 <h2 id="manifest">Manifest</h2>
285 <p>You must declare the "bookmarks" permission
286 in the <a href="manifest.html">extension manifest</a>
287 to use the bookmarks API.
288 For example:</p>
289 <pre>{
290 "name": "My extension",
291 ...
292 <b>"permissions": [
293 "bookmarks"
294 ]</b>,
295 ...
296 }</pre>
297 <h2 id="description">Objects and properties</h2>
298 <p>
299 Bookmarks are organized in a tree,
300 where each node in the tree
301 is either a bookmark or a folder
302 (sometimes called a <em>group</em>).
303 Each node in the tree
304 is represented by a
305 <a href="#type-BookmarkTreeNode"><code>BookmarkTreeNode</code></a> object.
306 </p>
307 <p>
308 <code>BookmarkTreeNode</code> properties
309 are used throughout the <code>chrome.bookmarks</code> API.
310 For example, when you call
311 <a href="#method-create"><code>create()</code></a>,
312 you pass in the new node's parent (<code>parentId</code>),
313 and, optionally, the node's
314 <code>index</code>, <code>title</code>, and <code>url</code> properties.
315 See <a href="#type-BookmarkTreeNode"><code>BookmarkTreeNode</code></a>
316 for information about the properties a node can have.
317 </p>
318 <p class="note"><b>Note:</b> You cannot use this API to add or remove entries
319 in the root folder. You also cannot rename, move, or remove the special
320 "Bookmarks Bar" and "Other Bookmarks" folders.</p>
321 <h2 id="overview-examples">Examples</h2>
322 <p>
323 The following code creates a folder with the title "Extension bookmarks".
324 The first argument to <code>create()</code> specifies properties
325 for the new folder.
326 The second argument defines a function
327 to be executed after the folder is created.
328 </p>
329 <pre>chrome.bookmarks.create({'parentId': bookmarkBar.id,
330 'title': 'Extension bookmarks'},
331 function(newFolder) {
332 console.log("added folder: " + newFolder.title);
333 });
334 </pre>
335 <p>
336 The next snippet creates a bookmark pointing to
337 the developer documentation for extensions.
338 Since nothing bad will happen if creating the bookmark fails,
339 this code doesn't bother to define a callback function.
340 </p>
341 <pre>chrome.bookmarks.create({'parentId': extensionsFolderId,
342 'title': 'Extensions doc',
343 'url': 'http://code.google.com/chrome/extensions'});
344 </pre>
345 <p>
346 For an example of using this API, see the
347 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension s/docs/examples/api/bookmarks/basic/">basic bookmarks sample</a>.
348 For other examples and for help in viewing the source code, see
349 <a href="samples.html">Samples</a>.
350 </p>
351 <!-- END AUTHORED CONTENT -->
352 </div>
353 <!-- API PAGE -->
354 <div class="apiPage">
355 <a name="apiReference"></a>
356 <h2>API reference: chrome.bookmarks</h2>
357 <!-- PROPERTIES -->
358 <!-- /apiGroup -->
359 <!-- METHODS -->
360 <div id="methodsTemplate" class="apiGroup">
361 <a name="global-methods"></a>
362 <h3>Methods</h3>
363 <!-- iterates over all functions -->
364 <div class="apiItem">
365 <a name="method-create"></a> <!-- method-anchor -->
366 <h4>create</h4>
367 <div class="summary">
368 <!-- Note: intentionally longer 80 columns -->
369 <span>chrome.bookmarks.create</span>(<span class="null"><span> object</span>
370 <var><span>bookmark</span></var></span><span class="option al"><span>, </span><span>function</span>
371 <var><span>callback</span></var></span>)</div>
372 <div class="description">
373 <p>Creates a bookmark or folder under the specified parentId. I f url is NULL or missing, it will be a folder.</p>
374 <!-- PARAMETERS -->
375 <h4>Parameters</h4>
376 <dl>
377 <div>
378 <div>
379 <dt>
380 <var>bookmark</var>
381 <em>
382 <!-- TYPE -->
383 <div style="display:inline">
384 (
385 <span id="typeTemplate">
386 <span>
387 <span>object</span>
388 </span>
389 </span>
390 )
391 </div>
392 </em>
393 </dt>
394 <dd class="todo">
395 Undocumented.
396 </dd>
397 <!-- OBJECT PROPERTIES -->
398 <dd>
399 <dl>
400 <div>
401 <div>
402 <dt>
403 <var>parentId</var>
404 <em>
405 <!-- TYPE -->
406 <div style="display:inline">
407 (
408 <span class="optional">optional</span>
409 <span id="typeTemplate">
410 <span>
411 <span>string</span>
412 </span>
413 </span>
414 )
415 </div>
416 </em>
417 </dt>
418 <dd>Defaults to the Other Bookmarks folder.</dd>
419 <!-- OBJECT PROPERTIES -->
420 <!-- OBJECT METHODS -->
421 <!-- OBJECT EVENT FIELDS -->
422 <!-- FUNCTION PARAMETERS -->
423 </div>
424 </div><div>
425 <div>
426 <dt>
427 <var>index</var>
428 <em>
429 <!-- TYPE -->
430 <div style="display:inline">
431 (
432 <span class="optional">optional</span>
433 <span id="typeTemplate">
434 <span>
435 <span>integer</span>
436 </span>
437 </span>
438 )
439 </div>
440 </em>
441 </dt>
442 <dd class="todo">
443 Undocumented.
444 </dd>
445 <!-- OBJECT PROPERTIES -->
446 <!-- OBJECT METHODS -->
447 <!-- OBJECT EVENT FIELDS -->
448 <!-- FUNCTION PARAMETERS -->
449 </div>
450 </div><div>
451 <div>
452 <dt>
453 <var>title</var>
454 <em>
455 <!-- TYPE -->
456 <div style="display:inline">
457 (
458 <span class="optional">optional</span>
459 <span id="typeTemplate">
460 <span>
461 <span>string</span>
462 </span>
463 </span>
464 )
465 </div>
466 </em>
467 </dt>
468 <dd class="todo">
469 Undocumented.
470 </dd>
471 <!-- OBJECT PROPERTIES -->
472 <!-- OBJECT METHODS -->
473 <!-- OBJECT EVENT FIELDS -->
474 <!-- FUNCTION PARAMETERS -->
475 </div>
476 </div><div>
477 <div>
478 <dt>
479 <var>url</var>
480 <em>
481 <!-- TYPE -->
482 <div style="display:inline">
483 (
484 <span class="optional">optional</span>
485 <span id="typeTemplate">
486 <span>
487 <span>string</span>
488 </span>
489 </span>
490 )
491 </div>
492 </em>
493 </dt>
494 <dd class="todo">
495 Undocumented.
496 </dd>
497 <!-- OBJECT PROPERTIES -->
498 <!-- OBJECT METHODS -->
499 <!-- OBJECT EVENT FIELDS -->
500 <!-- FUNCTION PARAMETERS -->
501 </div>
502 </div>
503 </dl>
504 </dd>
505 <!-- OBJECT METHODS -->
506 <!-- OBJECT EVENT FIELDS -->
507 <!-- FUNCTION PARAMETERS -->
508 </div>
509 </div><div>
510 <div>
511 <dt>
512 <var>callback</var>
513 <em>
514 <!-- TYPE -->
515 <div style="display:inline">
516 (
517 <span class="optional">optional</span>
518 <span id="typeTemplate">
519 <span>
520 <span>function</span>
521 </span>
522 </span>
523 )
524 </div>
525 </em>
526 </dt>
527 <dd class="todo">
528 Undocumented.
529 </dd>
530 <!-- OBJECT PROPERTIES -->
531 <!-- OBJECT METHODS -->
532 <!-- OBJECT EVENT FIELDS -->
533 <!-- FUNCTION PARAMETERS -->
534 </div>
535 </div>
536 </dl>
537 <!-- RETURNS -->
538 <dl>
539 </dl>
540 <!-- CALLBACK -->
541 <div>
542 <div>
543 <h4>Callback function</h4>
544 <p>
545 If you specify the <em>callback</em> parameter, it should
546 specify a function that looks like this:
547 </p>
548 <!-- Note: intentionally longer 80 columns -->
549 <pre>function(<span>BookmarkTreeNode result</span>) <span clas s="subdued">{...}</span>;</pre>
550 <dl>
551 <div>
552 <div>
553 <dt>
554 <var>result</var>
555 <em>
556 <!-- TYPE -->
557 <div style="display:inline">
558 (
559 <span id="typeTemplate">
560 <span>
561 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
562 </span>
563 </span>
564 )
565 </div>
566 </em>
567 </dt>
568 <dd class="todo">
569 Undocumented.
570 </dd>
571 <!-- OBJECT PROPERTIES -->
572 <!-- OBJECT METHODS -->
573 <!-- OBJECT EVENT FIELDS -->
574 <!-- FUNCTION PARAMETERS -->
575 </div>
576 </div>
577 </dl>
578 </div>
579 </div>
580 <!-- MIN_VERSION -->
581 </div> <!-- /description -->
582 </div><div class="apiItem">
583 <a name="method-get"></a> <!-- method-anchor -->
584 <h4>get</h4>
585 <div class="summary">
586 <!-- Note: intentionally longer 80 columns -->
587 <span>chrome.bookmarks.get</span>(<span class="null"><span>str ing or array of string</span>
588 <var><span>idOrIdList</span></var></span><span class="null "><span>, </span><span>function</span>
589 <var><span>callback</span></var></span>)</div>
590 <div class="description">
591 <p>Retrieves the specified BookmarkTreeNode(s).</p>
592 <!-- PARAMETERS -->
593 <h4>Parameters</h4>
594 <dl>
595 <div>
596 <div>
597 <dt>
598 <var>idOrIdList</var>
599 <em>
600 <!-- TYPE -->
601 <div style="display:inline">
602 (
603 <span id="typeTemplate">
604 <span>
605 <span>string or array of string</span>
606 </span>
607 </span>
608 )
609 </div>
610 </em>
611 </dt>
612 <dd>A single string-valued id, or an array of string-valued ids</dd>
613 <!-- OBJECT PROPERTIES -->
614 <!-- OBJECT METHODS -->
615 <!-- OBJECT EVENT FIELDS -->
616 <!-- FUNCTION PARAMETERS -->
617 </div>
618 </div><div>
619 <div>
620 <dt>
621 <var>callback</var>
622 <em>
623 <!-- TYPE -->
624 <div style="display:inline">
625 (
626 <span id="typeTemplate">
627 <span>
628 <span>function</span>
629 </span>
630 </span>
631 )
632 </div>
633 </em>
634 </dt>
635 <dd class="todo">
636 Undocumented.
637 </dd>
638 <!-- OBJECT PROPERTIES -->
639 <!-- OBJECT METHODS -->
640 <!-- OBJECT EVENT FIELDS -->
641 <!-- FUNCTION PARAMETERS -->
642 </div>
643 </div>
644 </dl>
645 <!-- RETURNS -->
646 <dl>
647 </dl>
648 <!-- CALLBACK -->
649 <div>
650 <div>
651 <h4>Callback function</h4>
652 <p>
653 The <em>callback</em> parameter should specify a function
654 that looks like this:
655 </p>
656 <!-- Note: intentionally longer 80 columns -->
657 <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
658 <dl>
659 <div>
660 <div>
661 <dt>
662 <var>results</var>
663 <em>
664 <!-- TYPE -->
665 <div style="display:inline">
666 (
667 <span id="typeTemplate">
668 <span>
669 <span>
670 array of <span><span>
671 <span>
672 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
673 </span>
674 </span></span>
675 </span>
676 </span>
677 </span>
678 )
679 </div>
680 </em>
681 </dt>
682 <dd class="todo">
683 Undocumented.
684 </dd>
685 <!-- OBJECT PROPERTIES -->
686 <!-- OBJECT METHODS -->
687 <!-- OBJECT EVENT FIELDS -->
688 <!-- FUNCTION PARAMETERS -->
689 </div>
690 </div>
691 </dl>
692 </div>
693 </div>
694 <!-- MIN_VERSION -->
695 </div> <!-- /description -->
696 </div><div class="apiItem">
697 <a name="method-getChildren"></a> <!-- method-anchor -->
698 <h4>getChildren</h4>
699 <div class="summary">
700 <!-- Note: intentionally longer 80 columns -->
701 <span>chrome.bookmarks.getChildren</span>(<span class="null">< span>string</span>
702 <var><span>id</span></var></span><span class="null"><span> , </span><span>function</span>
703 <var><span>callback</span></var></span>)</div>
704 <div class="description">
705 <p>Retrieves the children of the specified BookmarkTreeNode id.< /p>
706 <!-- PARAMETERS -->
707 <h4>Parameters</h4>
708 <dl>
709 <div>
710 <div>
711 <dt>
712 <var>id</var>
713 <em>
714 <!-- TYPE -->
715 <div style="display:inline">
716 (
717 <span id="typeTemplate">
718 <span>
719 <span>string</span>
720 </span>
721 </span>
722 )
723 </div>
724 </em>
725 </dt>
726 <dd class="todo">
727 Undocumented.
728 </dd>
729 <!-- OBJECT PROPERTIES -->
730 <!-- OBJECT METHODS -->
731 <!-- OBJECT EVENT FIELDS -->
732 <!-- FUNCTION PARAMETERS -->
733 </div>
734 </div><div>
735 <div>
736 <dt>
737 <var>callback</var>
738 <em>
739 <!-- TYPE -->
740 <div style="display:inline">
741 (
742 <span id="typeTemplate">
743 <span>
744 <span>function</span>
745 </span>
746 </span>
747 )
748 </div>
749 </em>
750 </dt>
751 <dd class="todo">
752 Undocumented.
753 </dd>
754 <!-- OBJECT PROPERTIES -->
755 <!-- OBJECT METHODS -->
756 <!-- OBJECT EVENT FIELDS -->
757 <!-- FUNCTION PARAMETERS -->
758 </div>
759 </div>
760 </dl>
761 <!-- RETURNS -->
762 <dl>
763 </dl>
764 <!-- CALLBACK -->
765 <div>
766 <div>
767 <h4>Callback function</h4>
768 <p>
769 The <em>callback</em> parameter should specify a function
770 that looks like this:
771 </p>
772 <!-- Note: intentionally longer 80 columns -->
773 <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
774 <dl>
775 <div>
776 <div>
777 <dt>
778 <var>results</var>
779 <em>
780 <!-- TYPE -->
781 <div style="display:inline">
782 (
783 <span id="typeTemplate">
784 <span>
785 <span>
786 array of <span><span>
787 <span>
788 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
789 </span>
790 </span></span>
791 </span>
792 </span>
793 </span>
794 )
795 </div>
796 </em>
797 </dt>
798 <dd class="todo">
799 Undocumented.
800 </dd>
801 <!-- OBJECT PROPERTIES -->
802 <!-- OBJECT METHODS -->
803 <!-- OBJECT EVENT FIELDS -->
804 <!-- FUNCTION PARAMETERS -->
805 </div>
806 </div>
807 </dl>
808 </div>
809 </div>
810 <!-- MIN_VERSION -->
811 </div> <!-- /description -->
812 </div><div class="apiItem">
813 <a name="method-getRecent"></a> <!-- method-anchor -->
814 <h4>getRecent</h4>
815 <div class="summary">
816 <!-- Note: intentionally longer 80 columns -->
817 <span>chrome.bookmarks.getRecent</span>(<span class="null"><sp an>integer</span>
818 <var><span>numberOfItems</span></var></span><span class="n ull"><span>, </span><span>function</span>
819 <var><span>callback</span></var></span>)</div>
820 <div class="description">
821 <p>Retrieves the recently added bookmarks.</p>
822 <!-- PARAMETERS -->
823 <h4>Parameters</h4>
824 <dl>
825 <div>
826 <div>
827 <dt>
828 <var>numberOfItems</var>
829 <em>
830 <!-- TYPE -->
831 <div style="display:inline">
832 (
833 <span id="typeTemplate">
834 <span>
835 <span>integer</span>
836 </span>
837 </span>
838 )
839 </div>
840 </em>
841 </dt>
842 <dd>The maximum number of items to return.</dd>
843 <!-- OBJECT PROPERTIES -->
844 <!-- OBJECT METHODS -->
845 <!-- OBJECT EVENT FIELDS -->
846 <!-- FUNCTION PARAMETERS -->
847 </div>
848 </div><div>
849 <div>
850 <dt>
851 <var>callback</var>
852 <em>
853 <!-- TYPE -->
854 <div style="display:inline">
855 (
856 <span id="typeTemplate">
857 <span>
858 <span>function</span>
859 </span>
860 </span>
861 )
862 </div>
863 </em>
864 </dt>
865 <dd class="todo">
866 Undocumented.
867 </dd>
868 <!-- OBJECT PROPERTIES -->
869 <!-- OBJECT METHODS -->
870 <!-- OBJECT EVENT FIELDS -->
871 <!-- FUNCTION PARAMETERS -->
872 </div>
873 </div>
874 </dl>
875 <!-- RETURNS -->
876 <dl>
877 </dl>
878 <!-- CALLBACK -->
879 <div>
880 <div>
881 <h4>Callback function</h4>
882 <p>
883 The <em>callback</em> parameter should specify a function
884 that looks like this:
885 </p>
886 <!-- Note: intentionally longer 80 columns -->
887 <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
888 <dl>
889 <div>
890 <div>
891 <dt>
892 <var>results</var>
893 <em>
894 <!-- TYPE -->
895 <div style="display:inline">
896 (
897 <span id="typeTemplate">
898 <span>
899 <span>
900 array of <span><span>
901 <span>
902 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
903 </span>
904 </span></span>
905 </span>
906 </span>
907 </span>
908 )
909 </div>
910 </em>
911 </dt>
912 <dd class="todo">
913 Undocumented.
914 </dd>
915 <!-- OBJECT PROPERTIES -->
916 <!-- OBJECT METHODS -->
917 <!-- OBJECT EVENT FIELDS -->
918 <!-- FUNCTION PARAMETERS -->
919 </div>
920 </div>
921 </dl>
922 </div>
923 </div>
924 <!-- MIN_VERSION -->
925 </div> <!-- /description -->
926 </div><div class="apiItem">
927 <a name="method-getSubTree"></a> <!-- method-anchor -->
928 <h4>getSubTree</h4>
929 <div class="summary">
930 <!-- Note: intentionally longer 80 columns -->
931 <span>chrome.bookmarks.getSubTree</span>(<span class="null"><s pan>string</span>
932 <var><span>id</span></var></span><span class="null"><span> , </span><span>function</span>
933 <var><span>callback</span></var></span>)</div>
934 <div class="description">
935 <p>Retrieves part of the Bookmarks hierarchy, starting at the sp ecified node.</p>
936 <!-- PARAMETERS -->
937 <h4>Parameters</h4>
938 <dl>
939 <div>
940 <div>
941 <dt>
942 <var>id</var>
943 <em>
944 <!-- TYPE -->
945 <div style="display:inline">
946 (
947 <span id="typeTemplate">
948 <span>
949 <span>string</span>
950 </span>
951 </span>
952 )
953 </div>
954 </em>
955 </dt>
956 <dd>The ID of the root of the subtree to retrieve.</dd>
957 <!-- OBJECT PROPERTIES -->
958 <!-- OBJECT METHODS -->
959 <!-- OBJECT EVENT FIELDS -->
960 <!-- FUNCTION PARAMETERS -->
961 </div>
962 </div><div>
963 <div>
964 <dt>
965 <var>callback</var>
966 <em>
967 <!-- TYPE -->
968 <div style="display:inline">
969 (
970 <span id="typeTemplate">
971 <span>
972 <span>function</span>
973 </span>
974 </span>
975 )
976 </div>
977 </em>
978 </dt>
979 <dd class="todo">
980 Undocumented.
981 </dd>
982 <!-- OBJECT PROPERTIES -->
983 <!-- OBJECT METHODS -->
984 <!-- OBJECT EVENT FIELDS -->
985 <!-- FUNCTION PARAMETERS -->
986 </div>
987 </div>
988 </dl>
989 <!-- RETURNS -->
990 <dl>
991 </dl>
992 <!-- CALLBACK -->
993 <div>
994 <div>
995 <h4>Callback function</h4>
996 <p>
997 The <em>callback</em> parameter should specify a function
998 that looks like this:
999 </p>
1000 <!-- Note: intentionally longer 80 columns -->
1001 <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
1002 <dl>
1003 <div>
1004 <div>
1005 <dt>
1006 <var>results</var>
1007 <em>
1008 <!-- TYPE -->
1009 <div style="display:inline">
1010 (
1011 <span id="typeTemplate">
1012 <span>
1013 <span>
1014 array of <span><span>
1015 <span>
1016 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
1017 </span>
1018 </span></span>
1019 </span>
1020 </span>
1021 </span>
1022 )
1023 </div>
1024 </em>
1025 </dt>
1026 <dd class="todo">
1027 Undocumented.
1028 </dd>
1029 <!-- OBJECT PROPERTIES -->
1030 <!-- OBJECT METHODS -->
1031 <!-- OBJECT EVENT FIELDS -->
1032 <!-- FUNCTION PARAMETERS -->
1033 </div>
1034 </div>
1035 </dl>
1036 </div>
1037 </div>
1038 <!-- MIN_VERSION -->
1039 </div> <!-- /description -->
1040 </div><div class="apiItem">
1041 <a name="method-getTree"></a> <!-- method-anchor -->
1042 <h4>getTree</h4>
1043 <div class="summary">
1044 <!-- Note: intentionally longer 80 columns -->
1045 <span>chrome.bookmarks.getTree</span>(<span class="null"><span >function</span>
1046 <var><span>callback</span></var></span>)</div>
1047 <div class="description">
1048 <p>Retrieves the entire Bookmarks hierarchy.</p>
1049 <!-- PARAMETERS -->
1050 <h4>Parameters</h4>
1051 <dl>
1052 <div>
1053 <div>
1054 <dt>
1055 <var>callback</var>
1056 <em>
1057 <!-- TYPE -->
1058 <div style="display:inline">
1059 (
1060 <span id="typeTemplate">
1061 <span>
1062 <span>function</span>
1063 </span>
1064 </span>
1065 )
1066 </div>
1067 </em>
1068 </dt>
1069 <dd class="todo">
1070 Undocumented.
1071 </dd>
1072 <!-- OBJECT PROPERTIES -->
1073 <!-- OBJECT METHODS -->
1074 <!-- OBJECT EVENT FIELDS -->
1075 <!-- FUNCTION PARAMETERS -->
1076 </div>
1077 </div>
1078 </dl>
1079 <!-- RETURNS -->
1080 <dl>
1081 </dl>
1082 <!-- CALLBACK -->
1083 <div>
1084 <div>
1085 <h4>Callback function</h4>
1086 <p>
1087 The <em>callback</em> parameter should specify a function
1088 that looks like this:
1089 </p>
1090 <!-- Note: intentionally longer 80 columns -->
1091 <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
1092 <dl>
1093 <div>
1094 <div>
1095 <dt>
1096 <var>results</var>
1097 <em>
1098 <!-- TYPE -->
1099 <div style="display:inline">
1100 (
1101 <span id="typeTemplate">
1102 <span>
1103 <span>
1104 array of <span><span>
1105 <span>
1106 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
1107 </span>
1108 </span></span>
1109 </span>
1110 </span>
1111 </span>
1112 )
1113 </div>
1114 </em>
1115 </dt>
1116 <dd class="todo">
1117 Undocumented.
1118 </dd>
1119 <!-- OBJECT PROPERTIES -->
1120 <!-- OBJECT METHODS -->
1121 <!-- OBJECT EVENT FIELDS -->
1122 <!-- FUNCTION PARAMETERS -->
1123 </div>
1124 </div>
1125 </dl>
1126 </div>
1127 </div>
1128 <!-- MIN_VERSION -->
1129 </div> <!-- /description -->
1130 </div><div class="apiItem">
1131 <a name="method-move"></a> <!-- method-anchor -->
1132 <h4>move</h4>
1133 <div class="summary">
1134 <!-- Note: intentionally longer 80 columns -->
1135 <span>chrome.bookmarks.move</span>(<span class="null"><span>st ring</span>
1136 <var><span>id</span></var></span><span class="null"><span> , </span><span>object</span>
1137 <var><span>destination</span></var></span><span class="opt ional"><span>, </span><span>function</span>
1138 <var><span>callback</span></var></span>)</div>
1139 <div class="description">
1140 <p>Moves the specified BookmarkTreeNode to the provided location .</p>
1141 <!-- PARAMETERS -->
1142 <h4>Parameters</h4>
1143 <dl>
1144 <div>
1145 <div>
1146 <dt>
1147 <var>id</var>
1148 <em>
1149 <!-- TYPE -->
1150 <div style="display:inline">
1151 (
1152 <span id="typeTemplate">
1153 <span>
1154 <span>string</span>
1155 </span>
1156 </span>
1157 )
1158 </div>
1159 </em>
1160 </dt>
1161 <dd class="todo">
1162 Undocumented.
1163 </dd>
1164 <!-- OBJECT PROPERTIES -->
1165 <!-- OBJECT METHODS -->
1166 <!-- OBJECT EVENT FIELDS -->
1167 <!-- FUNCTION PARAMETERS -->
1168 </div>
1169 </div><div>
1170 <div>
1171 <dt>
1172 <var>destination</var>
1173 <em>
1174 <!-- TYPE -->
1175 <div style="display:inline">
1176 (
1177 <span id="typeTemplate">
1178 <span>
1179 <span>object</span>
1180 </span>
1181 </span>
1182 )
1183 </div>
1184 </em>
1185 </dt>
1186 <dd class="todo">
1187 Undocumented.
1188 </dd>
1189 <!-- OBJECT PROPERTIES -->
1190 <dd>
1191 <dl>
1192 <div>
1193 <div>
1194 <dt>
1195 <var>parentId</var>
1196 <em>
1197 <!-- TYPE -->
1198 <div style="display:inline">
1199 (
1200 <span id="typeTemplate">
1201 <span>
1202 <span>string</span>
1203 </span>
1204 </span>
1205 )
1206 </div>
1207 </em>
1208 </dt>
1209 <dd class="todo">
1210 Undocumented.
1211 </dd>
1212 <!-- OBJECT PROPERTIES -->
1213 <!-- OBJECT METHODS -->
1214 <!-- OBJECT EVENT FIELDS -->
1215 <!-- FUNCTION PARAMETERS -->
1216 </div>
1217 </div><div>
1218 <div>
1219 <dt>
1220 <var>index</var>
1221 <em>
1222 <!-- TYPE -->
1223 <div style="display:inline">
1224 (
1225 <span class="optional">optional</span>
1226 <span id="typeTemplate">
1227 <span>
1228 <span>integer</span>
1229 </span>
1230 </span>
1231 )
1232 </div>
1233 </em>
1234 </dt>
1235 <dd class="todo">
1236 Undocumented.
1237 </dd>
1238 <!-- OBJECT PROPERTIES -->
1239 <!-- OBJECT METHODS -->
1240 <!-- OBJECT EVENT FIELDS -->
1241 <!-- FUNCTION PARAMETERS -->
1242 </div>
1243 </div>
1244 </dl>
1245 </dd>
1246 <!-- OBJECT METHODS -->
1247 <!-- OBJECT EVENT FIELDS -->
1248 <!-- FUNCTION PARAMETERS -->
1249 </div>
1250 </div><div>
1251 <div>
1252 <dt>
1253 <var>callback</var>
1254 <em>
1255 <!-- TYPE -->
1256 <div style="display:inline">
1257 (
1258 <span class="optional">optional</span>
1259 <span id="typeTemplate">
1260 <span>
1261 <span>function</span>
1262 </span>
1263 </span>
1264 )
1265 </div>
1266 </em>
1267 </dt>
1268 <dd class="todo">
1269 Undocumented.
1270 </dd>
1271 <!-- OBJECT PROPERTIES -->
1272 <!-- OBJECT METHODS -->
1273 <!-- OBJECT EVENT FIELDS -->
1274 <!-- FUNCTION PARAMETERS -->
1275 </div>
1276 </div>
1277 </dl>
1278 <!-- RETURNS -->
1279 <dl>
1280 </dl>
1281 <!-- CALLBACK -->
1282 <div>
1283 <div>
1284 <h4>Callback function</h4>
1285 <p>
1286 If you specify the <em>callback</em> parameter, it should
1287 specify a function that looks like this:
1288 </p>
1289 <!-- Note: intentionally longer 80 columns -->
1290 <pre>function(<span>BookmarkTreeNode result</span>) <span clas s="subdued">{...}</span>;</pre>
1291 <dl>
1292 <div>
1293 <div>
1294 <dt>
1295 <var>result</var>
1296 <em>
1297 <!-- TYPE -->
1298 <div style="display:inline">
1299 (
1300 <span id="typeTemplate">
1301 <span>
1302 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
1303 </span>
1304 </span>
1305 )
1306 </div>
1307 </em>
1308 </dt>
1309 <dd class="todo">
1310 Undocumented.
1311 </dd>
1312 <!-- OBJECT PROPERTIES -->
1313 <!-- OBJECT METHODS -->
1314 <!-- OBJECT EVENT FIELDS -->
1315 <!-- FUNCTION PARAMETERS -->
1316 </div>
1317 </div>
1318 </dl>
1319 </div>
1320 </div>
1321 <!-- MIN_VERSION -->
1322 </div> <!-- /description -->
1323 </div><div class="apiItem">
1324 <a name="method-remove"></a> <!-- method-anchor -->
1325 <h4>remove</h4>
1326 <div class="summary">
1327 <!-- Note: intentionally longer 80 columns -->
1328 <span>chrome.bookmarks.remove</span>(<span class="null"><span> string</span>
1329 <var><span>id</span></var></span><span class="optional"><s pan>, </span><span>function</span>
1330 <var><span>callback</span></var></span>)</div>
1331 <div class="description">
1332 <p>Removes a bookmark or an empty bookmark folder.</p>
1333 <!-- PARAMETERS -->
1334 <h4>Parameters</h4>
1335 <dl>
1336 <div>
1337 <div>
1338 <dt>
1339 <var>id</var>
1340 <em>
1341 <!-- TYPE -->
1342 <div style="display:inline">
1343 (
1344 <span id="typeTemplate">
1345 <span>
1346 <span>string</span>
1347 </span>
1348 </span>
1349 )
1350 </div>
1351 </em>
1352 </dt>
1353 <dd class="todo">
1354 Undocumented.
1355 </dd>
1356 <!-- OBJECT PROPERTIES -->
1357 <!-- OBJECT METHODS -->
1358 <!-- OBJECT EVENT FIELDS -->
1359 <!-- FUNCTION PARAMETERS -->
1360 </div>
1361 </div><div>
1362 <div>
1363 <dt>
1364 <var>callback</var>
1365 <em>
1366 <!-- TYPE -->
1367 <div style="display:inline">
1368 (
1369 <span class="optional">optional</span>
1370 <span id="typeTemplate">
1371 <span>
1372 <span>function</span>
1373 </span>
1374 </span>
1375 )
1376 </div>
1377 </em>
1378 </dt>
1379 <dd class="todo">
1380 Undocumented.
1381 </dd>
1382 <!-- OBJECT PROPERTIES -->
1383 <!-- OBJECT METHODS -->
1384 <!-- OBJECT EVENT FIELDS -->
1385 <!-- FUNCTION PARAMETERS -->
1386 </div>
1387 </div>
1388 </dl>
1389 <!-- RETURNS -->
1390 <dl>
1391 </dl>
1392 <!-- CALLBACK -->
1393 <div>
1394 <div>
1395 <h4>Callback function</h4>
1396 <p>
1397 If you specify the <em>callback</em> parameter, it should
1398 specify a function that looks like this:
1399 </p>
1400 <!-- Note: intentionally longer 80 columns -->
1401 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1402 <dl>
1403 </dl>
1404 </div>
1405 </div>
1406 <!-- MIN_VERSION -->
1407 </div> <!-- /description -->
1408 </div><div class="apiItem">
1409 <a name="method-removeTree"></a> <!-- method-anchor -->
1410 <h4>removeTree</h4>
1411 <div class="summary">
1412 <!-- Note: intentionally longer 80 columns -->
1413 <span>chrome.bookmarks.removeTree</span>(<span class="null"><s pan>string</span>
1414 <var><span>id</span></var></span><span class="optional"><s pan>, </span><span>function</span>
1415 <var><span>callback</span></var></span>)</div>
1416 <div class="description">
1417 <p>Recursively removes a bookmark folder.</p>
1418 <!-- PARAMETERS -->
1419 <h4>Parameters</h4>
1420 <dl>
1421 <div>
1422 <div>
1423 <dt>
1424 <var>id</var>
1425 <em>
1426 <!-- TYPE -->
1427 <div style="display:inline">
1428 (
1429 <span id="typeTemplate">
1430 <span>
1431 <span>string</span>
1432 </span>
1433 </span>
1434 )
1435 </div>
1436 </em>
1437 </dt>
1438 <dd class="todo">
1439 Undocumented.
1440 </dd>
1441 <!-- OBJECT PROPERTIES -->
1442 <!-- OBJECT METHODS -->
1443 <!-- OBJECT EVENT FIELDS -->
1444 <!-- FUNCTION PARAMETERS -->
1445 </div>
1446 </div><div>
1447 <div>
1448 <dt>
1449 <var>callback</var>
1450 <em>
1451 <!-- TYPE -->
1452 <div style="display:inline">
1453 (
1454 <span class="optional">optional</span>
1455 <span id="typeTemplate">
1456 <span>
1457 <span>function</span>
1458 </span>
1459 </span>
1460 )
1461 </div>
1462 </em>
1463 </dt>
1464 <dd class="todo">
1465 Undocumented.
1466 </dd>
1467 <!-- OBJECT PROPERTIES -->
1468 <!-- OBJECT METHODS -->
1469 <!-- OBJECT EVENT FIELDS -->
1470 <!-- FUNCTION PARAMETERS -->
1471 </div>
1472 </div>
1473 </dl>
1474 <!-- RETURNS -->
1475 <dl>
1476 </dl>
1477 <!-- CALLBACK -->
1478 <div>
1479 <div>
1480 <h4>Callback function</h4>
1481 <p>
1482 If you specify the <em>callback</em> parameter, it should
1483 specify a function that looks like this:
1484 </p>
1485 <!-- Note: intentionally longer 80 columns -->
1486 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1487 <dl>
1488 </dl>
1489 </div>
1490 </div>
1491 <!-- MIN_VERSION -->
1492 </div> <!-- /description -->
1493 </div><div class="apiItem">
1494 <a name="method-search"></a> <!-- method-anchor -->
1495 <h4>search</h4>
1496 <div class="summary">
1497 <!-- Note: intentionally longer 80 columns -->
1498 <span>chrome.bookmarks.search</span>(<span class="null"><span> string</span>
1499 <var><span>query</span></var></span><span class="null"><sp an>, </span><span>function</span>
1500 <var><span>callback</span></var></span>)</div>
1501 <div class="description">
1502 <p>Searches for BookmarkTreeNodes matching the given query.</p>
1503 <!-- PARAMETERS -->
1504 <h4>Parameters</h4>
1505 <dl>
1506 <div>
1507 <div>
1508 <dt>
1509 <var>query</var>
1510 <em>
1511 <!-- TYPE -->
1512 <div style="display:inline">
1513 (
1514 <span id="typeTemplate">
1515 <span>
1516 <span>string</span>
1517 </span>
1518 </span>
1519 )
1520 </div>
1521 </em>
1522 </dt>
1523 <dd class="todo">
1524 Undocumented.
1525 </dd>
1526 <!-- OBJECT PROPERTIES -->
1527 <!-- OBJECT METHODS -->
1528 <!-- OBJECT EVENT FIELDS -->
1529 <!-- FUNCTION PARAMETERS -->
1530 </div>
1531 </div><div>
1532 <div>
1533 <dt>
1534 <var>callback</var>
1535 <em>
1536 <!-- TYPE -->
1537 <div style="display:inline">
1538 (
1539 <span id="typeTemplate">
1540 <span>
1541 <span>function</span>
1542 </span>
1543 </span>
1544 )
1545 </div>
1546 </em>
1547 </dt>
1548 <dd class="todo">
1549 Undocumented.
1550 </dd>
1551 <!-- OBJECT PROPERTIES -->
1552 <!-- OBJECT METHODS -->
1553 <!-- OBJECT EVENT FIELDS -->
1554 <!-- FUNCTION PARAMETERS -->
1555 </div>
1556 </div>
1557 </dl>
1558 <!-- RETURNS -->
1559 <dl>
1560 </dl>
1561 <!-- CALLBACK -->
1562 <div>
1563 <div>
1564 <h4>Callback function</h4>
1565 <p>
1566 The <em>callback</em> parameter should specify a function
1567 that looks like this:
1568 </p>
1569 <!-- Note: intentionally longer 80 columns -->
1570 <pre>function(<span>array of BookmarkTreeNode results</span>) <span class="subdued">{...}</span>;</pre>
1571 <dl>
1572 <div>
1573 <div>
1574 <dt>
1575 <var>results</var>
1576 <em>
1577 <!-- TYPE -->
1578 <div style="display:inline">
1579 (
1580 <span id="typeTemplate">
1581 <span>
1582 <span>
1583 array of <span><span>
1584 <span>
1585 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
1586 </span>
1587 </span></span>
1588 </span>
1589 </span>
1590 </span>
1591 )
1592 </div>
1593 </em>
1594 </dt>
1595 <dd class="todo">
1596 Undocumented.
1597 </dd>
1598 <!-- OBJECT PROPERTIES -->
1599 <!-- OBJECT METHODS -->
1600 <!-- OBJECT EVENT FIELDS -->
1601 <!-- FUNCTION PARAMETERS -->
1602 </div>
1603 </div>
1604 </dl>
1605 </div>
1606 </div>
1607 <!-- MIN_VERSION -->
1608 </div> <!-- /description -->
1609 </div><div class="apiItem">
1610 <a name="method-update"></a> <!-- method-anchor -->
1611 <h4>update</h4>
1612 <div class="summary">
1613 <!-- Note: intentionally longer 80 columns -->
1614 <span>chrome.bookmarks.update</span>(<span class="null"><span> string</span>
1615 <var><span>id</span></var></span><span class="null"><span> , </span><span>object</span>
1616 <var><span>changes</span></var></span><span class="optiona l"><span>, </span><span>function</span>
1617 <var><span>callback</span></var></span>)</div>
1618 <div class="description">
1619 <p>Updates the properties of a bookmark or folder. Specify only the properties that you want to change; unspecified properties will be left unch anged. <b>Note:</b> Currently, only 'title' and 'url' are supported.</p>
1620 <!-- PARAMETERS -->
1621 <h4>Parameters</h4>
1622 <dl>
1623 <div>
1624 <div>
1625 <dt>
1626 <var>id</var>
1627 <em>
1628 <!-- TYPE -->
1629 <div style="display:inline">
1630 (
1631 <span id="typeTemplate">
1632 <span>
1633 <span>string</span>
1634 </span>
1635 </span>
1636 )
1637 </div>
1638 </em>
1639 </dt>
1640 <dd class="todo">
1641 Undocumented.
1642 </dd>
1643 <!-- OBJECT PROPERTIES -->
1644 <!-- OBJECT METHODS -->
1645 <!-- OBJECT EVENT FIELDS -->
1646 <!-- FUNCTION PARAMETERS -->
1647 </div>
1648 </div><div>
1649 <div>
1650 <dt>
1651 <var>changes</var>
1652 <em>
1653 <!-- TYPE -->
1654 <div style="display:inline">
1655 (
1656 <span id="typeTemplate">
1657 <span>
1658 <span>object</span>
1659 </span>
1660 </span>
1661 )
1662 </div>
1663 </em>
1664 </dt>
1665 <dd class="todo">
1666 Undocumented.
1667 </dd>
1668 <!-- OBJECT PROPERTIES -->
1669 <dd>
1670 <dl>
1671 <div>
1672 <div>
1673 <dt>
1674 <var>title</var>
1675 <em>
1676 <!-- TYPE -->
1677 <div style="display:inline">
1678 (
1679 <span class="optional">optional</span>
1680 <span id="typeTemplate">
1681 <span>
1682 <span>string</span>
1683 </span>
1684 </span>
1685 )
1686 </div>
1687 </em>
1688 </dt>
1689 <dd class="todo">
1690 Undocumented.
1691 </dd>
1692 <!-- OBJECT PROPERTIES -->
1693 <!-- OBJECT METHODS -->
1694 <!-- OBJECT EVENT FIELDS -->
1695 <!-- FUNCTION PARAMETERS -->
1696 </div>
1697 </div><div>
1698 <div>
1699 <dt>
1700 <var>url</var>
1701 <em>
1702 <!-- TYPE -->
1703 <div style="display:inline">
1704 (
1705 <span class="optional">optional</span>
1706 <span id="typeTemplate">
1707 <span>
1708 <span>string</span>
1709 </span>
1710 </span>
1711 )
1712 </div>
1713 </em>
1714 </dt>
1715 <dd class="todo">
1716 Undocumented.
1717 </dd>
1718 <!-- OBJECT PROPERTIES -->
1719 <!-- OBJECT METHODS -->
1720 <!-- OBJECT EVENT FIELDS -->
1721 <!-- FUNCTION PARAMETERS -->
1722 </div>
1723 </div>
1724 </dl>
1725 </dd>
1726 <!-- OBJECT METHODS -->
1727 <!-- OBJECT EVENT FIELDS -->
1728 <!-- FUNCTION PARAMETERS -->
1729 </div>
1730 </div><div>
1731 <div>
1732 <dt>
1733 <var>callback</var>
1734 <em>
1735 <!-- TYPE -->
1736 <div style="display:inline">
1737 (
1738 <span class="optional">optional</span>
1739 <span id="typeTemplate">
1740 <span>
1741 <span>function</span>
1742 </span>
1743 </span>
1744 )
1745 </div>
1746 </em>
1747 </dt>
1748 <dd class="todo">
1749 Undocumented.
1750 </dd>
1751 <!-- OBJECT PROPERTIES -->
1752 <!-- OBJECT METHODS -->
1753 <!-- OBJECT EVENT FIELDS -->
1754 <!-- FUNCTION PARAMETERS -->
1755 </div>
1756 </div>
1757 </dl>
1758 <!-- RETURNS -->
1759 <dl>
1760 </dl>
1761 <!-- CALLBACK -->
1762 <div>
1763 <div>
1764 <h4>Callback function</h4>
1765 <p>
1766 If you specify the <em>callback</em> parameter, it should
1767 specify a function that looks like this:
1768 </p>
1769 <!-- Note: intentionally longer 80 columns -->
1770 <pre>function(<span>BookmarkTreeNode result</span>) <span clas s="subdued">{...}</span>;</pre>
1771 <dl>
1772 <div>
1773 <div>
1774 <dt>
1775 <var>result</var>
1776 <em>
1777 <!-- TYPE -->
1778 <div style="display:inline">
1779 (
1780 <span id="typeTemplate">
1781 <span>
1782 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
1783 </span>
1784 </span>
1785 )
1786 </div>
1787 </em>
1788 </dt>
1789 <dd class="todo">
1790 Undocumented.
1791 </dd>
1792 <!-- OBJECT PROPERTIES -->
1793 <!-- OBJECT METHODS -->
1794 <!-- OBJECT EVENT FIELDS -->
1795 <!-- FUNCTION PARAMETERS -->
1796 </div>
1797 </div>
1798 </dl>
1799 </div>
1800 </div>
1801 <!-- MIN_VERSION -->
1802 </div> <!-- /description -->
1803 </div> <!-- /apiItem -->
1804 </div> <!-- /apiGroup -->
1805 <!-- EVENTS -->
1806 <div id="eventsTemplate" class="apiGroup">
1807 <a name="global-events"></a>
1808 <h3>Events</h3>
1809 <!-- iterates over all events -->
1810 <div class="apiItem">
1811 <a name="event-onChanged"></a>
1812 <h4>onChanged</h4>
1813 <div class="summary">
1814 <!-- Note: intentionally longer 80 columns -->
1815 <span class="subdued">chrome.bookmarks.</span><span>onChanged</s pan><span class="subdued">.addListener</span>(function(<span>string id, object c hangeInfo</span>) <span class="subdued">{...}</span><span></span>);
1816 </div>
1817 <div class="description">
1818 <p>Fired when a bookmark or folder changes. <b>Note:</b> Curren tly, only title and url changes trigger this.</p>
1819 <!-- LISTENER PARAMETERS -->
1820 <div>
1821 <h4>Listener parameters</h4>
1822 <dl>
1823 <div>
1824 <div>
1825 <dt>
1826 <var>id</var>
1827 <em>
1828 <!-- TYPE -->
1829 <div style="display:inline">
1830 (
1831 <span id="typeTemplate">
1832 <span>
1833 <span>string</span>
1834 </span>
1835 </span>
1836 )
1837 </div>
1838 </em>
1839 </dt>
1840 <dd class="todo">
1841 Undocumented.
1842 </dd>
1843 <!-- OBJECT PROPERTIES -->
1844 <!-- OBJECT METHODS -->
1845 <!-- OBJECT EVENT FIELDS -->
1846 <!-- FUNCTION PARAMETERS -->
1847 </div>
1848 </div><div>
1849 <div>
1850 <dt>
1851 <var>changeInfo</var>
1852 <em>
1853 <!-- TYPE -->
1854 <div style="display:inline">
1855 (
1856 <span id="typeTemplate">
1857 <span>
1858 <span>object</span>
1859 </span>
1860 </span>
1861 )
1862 </div>
1863 </em>
1864 </dt>
1865 <dd class="todo">
1866 Undocumented.
1867 </dd>
1868 <!-- OBJECT PROPERTIES -->
1869 <dd>
1870 <dl>
1871 <div>
1872 <div>
1873 <dt>
1874 <var>title</var>
1875 <em>
1876 <!-- TYPE -->
1877 <div style="display:inline">
1878 (
1879 <span id="typeTemplate">
1880 <span>
1881 <span>string</span>
1882 </span>
1883 </span>
1884 )
1885 </div>
1886 </em>
1887 </dt>
1888 <dd class="todo">
1889 Undocumented.
1890 </dd>
1891 <!-- OBJECT PROPERTIES -->
1892 <!-- OBJECT METHODS -->
1893 <!-- OBJECT EVENT FIELDS -->
1894 <!-- FUNCTION PARAMETERS -->
1895 </div>
1896 </div><div>
1897 <div>
1898 <dt>
1899 <var>url</var>
1900 <em>
1901 <!-- TYPE -->
1902 <div style="display:inline">
1903 (
1904 <span class="optional">optional</span>
1905 <span id="typeTemplate">
1906 <span>
1907 <span>string</span>
1908 </span>
1909 </span>
1910 )
1911 </div>
1912 </em>
1913 </dt>
1914 <dd class="todo">
1915 Undocumented.
1916 </dd>
1917 <!-- OBJECT PROPERTIES -->
1918 <!-- OBJECT METHODS -->
1919 <!-- OBJECT EVENT FIELDS -->
1920 <!-- FUNCTION PARAMETERS -->
1921 </div>
1922 </div>
1923 </dl>
1924 </dd>
1925 <!-- OBJECT METHODS -->
1926 <!-- OBJECT EVENT FIELDS -->
1927 <!-- FUNCTION PARAMETERS -->
1928 </div>
1929 </div>
1930 </dl>
1931 </div>
1932 <!-- EXTRA PARAMETERS -->
1933 <!-- LISTENER RETURN VALUE -->
1934 <dl>
1935 </dl>
1936 </div> <!-- /description -->
1937 <!-- /description -->
1938 </div><div class="apiItem">
1939 <a name="event-onChildrenReordered"></a>
1940 <h4>onChildrenReordered</h4>
1941 <div class="summary">
1942 <!-- Note: intentionally longer 80 columns -->
1943 <span class="subdued">chrome.bookmarks.</span><span>onChildrenRe ordered</span><span class="subdued">.addListener</span>(function(<span>string id , object reorderInfo</span>) <span class="subdued">{...}</span><span></span>);
1944 </div>
1945 <div class="description">
1946 <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 mo ve().</p>
1947 <!-- LISTENER PARAMETERS -->
1948 <div>
1949 <h4>Listener parameters</h4>
1950 <dl>
1951 <div>
1952 <div>
1953 <dt>
1954 <var>id</var>
1955 <em>
1956 <!-- TYPE -->
1957 <div style="display:inline">
1958 (
1959 <span id="typeTemplate">
1960 <span>
1961 <span>string</span>
1962 </span>
1963 </span>
1964 )
1965 </div>
1966 </em>
1967 </dt>
1968 <dd class="todo">
1969 Undocumented.
1970 </dd>
1971 <!-- OBJECT PROPERTIES -->
1972 <!-- OBJECT METHODS -->
1973 <!-- OBJECT EVENT FIELDS -->
1974 <!-- FUNCTION PARAMETERS -->
1975 </div>
1976 </div><div>
1977 <div>
1978 <dt>
1979 <var>reorderInfo</var>
1980 <em>
1981 <!-- TYPE -->
1982 <div style="display:inline">
1983 (
1984 <span id="typeTemplate">
1985 <span>
1986 <span>object</span>
1987 </span>
1988 </span>
1989 )
1990 </div>
1991 </em>
1992 </dt>
1993 <dd class="todo">
1994 Undocumented.
1995 </dd>
1996 <!-- OBJECT PROPERTIES -->
1997 <dd>
1998 <dl>
1999 <div>
2000 <div>
2001 <dt>
2002 <var>childIds</var>
2003 <em>
2004 <!-- TYPE -->
2005 <div style="display:inline">
2006 (
2007 <span id="typeTemplate">
2008 <span>
2009 <span>
2010 array of <span><span>
2011 <span>
2012 <span>string</span>
2013 </span>
2014 </span></span>
2015 </span>
2016 </span>
2017 </span>
2018 )
2019 </div>
2020 </em>
2021 </dt>
2022 <dd class="todo">
2023 Undocumented.
2024 </dd>
2025 <!-- OBJECT PROPERTIES -->
2026 <!-- OBJECT METHODS -->
2027 <!-- OBJECT EVENT FIELDS -->
2028 <!-- FUNCTION PARAMETERS -->
2029 </div>
2030 </div>
2031 </dl>
2032 </dd>
2033 <!-- OBJECT METHODS -->
2034 <!-- OBJECT EVENT FIELDS -->
2035 <!-- FUNCTION PARAMETERS -->
2036 </div>
2037 </div>
2038 </dl>
2039 </div>
2040 <!-- EXTRA PARAMETERS -->
2041 <!-- LISTENER RETURN VALUE -->
2042 <dl>
2043 </dl>
2044 </div> <!-- /description -->
2045 <!-- /description -->
2046 </div><div class="apiItem">
2047 <a name="event-onCreated"></a>
2048 <h4>onCreated</h4>
2049 <div class="summary">
2050 <!-- Note: intentionally longer 80 columns -->
2051 <span class="subdued">chrome.bookmarks.</span><span>onCreated</s pan><span class="subdued">.addListener</span>(function(<span>string id, Bookmark TreeNode bookmark</span>) <span class="subdued">{...}</span><span></span>);
2052 </div>
2053 <div class="description">
2054 <p>Fired when a bookmark or folder is created.</p>
2055 <!-- LISTENER PARAMETERS -->
2056 <div>
2057 <h4>Listener parameters</h4>
2058 <dl>
2059 <div>
2060 <div>
2061 <dt>
2062 <var>id</var>
2063 <em>
2064 <!-- TYPE -->
2065 <div style="display:inline">
2066 (
2067 <span id="typeTemplate">
2068 <span>
2069 <span>string</span>
2070 </span>
2071 </span>
2072 )
2073 </div>
2074 </em>
2075 </dt>
2076 <dd class="todo">
2077 Undocumented.
2078 </dd>
2079 <!-- OBJECT PROPERTIES -->
2080 <!-- OBJECT METHODS -->
2081 <!-- OBJECT EVENT FIELDS -->
2082 <!-- FUNCTION PARAMETERS -->
2083 </div>
2084 </div><div>
2085 <div>
2086 <dt>
2087 <var>bookmark</var>
2088 <em>
2089 <!-- TYPE -->
2090 <div style="display:inline">
2091 (
2092 <span id="typeTemplate">
2093 <span>
2094 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
2095 </span>
2096 </span>
2097 )
2098 </div>
2099 </em>
2100 </dt>
2101 <dd class="todo">
2102 Undocumented.
2103 </dd>
2104 <!-- OBJECT PROPERTIES -->
2105 <!-- OBJECT METHODS -->
2106 <!-- OBJECT EVENT FIELDS -->
2107 <!-- FUNCTION PARAMETERS -->
2108 </div>
2109 </div>
2110 </dl>
2111 </div>
2112 <!-- EXTRA PARAMETERS -->
2113 <!-- LISTENER RETURN VALUE -->
2114 <dl>
2115 </dl>
2116 </div> <!-- /description -->
2117 <!-- /description -->
2118 </div><div class="apiItem">
2119 <a name="event-onImportBegan"></a>
2120 <h4>onImportBegan</h4>
2121 <div class="summary">
2122 <!-- Note: intentionally longer 80 columns -->
2123 <span class="subdued">chrome.bookmarks.</span><span>onImportBega n</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);
2124 </div>
2125 <div class="description">
2126 <p>Fired when a bookmark import session is begun. Expensive obs ervers should ignore handleCreated updates until onImportEnded is fired. Observ ers should still handle other notifications immediately.</p>
2127 <!-- LISTENER PARAMETERS -->
2128 <!-- EXTRA PARAMETERS -->
2129 <!-- LISTENER RETURN VALUE -->
2130 <dl>
2131 </dl>
2132 </div> <!-- /description -->
2133 <!-- /description -->
2134 </div><div class="apiItem">
2135 <a name="event-onImportEnded"></a>
2136 <h4>onImportEnded</h4>
2137 <div class="summary">
2138 <!-- Note: intentionally longer 80 columns -->
2139 <span class="subdued">chrome.bookmarks.</span><span>onImportEnde d</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);
2140 </div>
2141 <div class="description">
2142 <p>Fired when a bookmark import session is ended.</p>
2143 <!-- LISTENER PARAMETERS -->
2144 <!-- EXTRA PARAMETERS -->
2145 <!-- LISTENER RETURN VALUE -->
2146 <dl>
2147 </dl>
2148 </div> <!-- /description -->
2149 <!-- /description -->
2150 </div><div class="apiItem">
2151 <a name="event-onMoved"></a>
2152 <h4>onMoved</h4>
2153 <div class="summary">
2154 <!-- Note: intentionally longer 80 columns -->
2155 <span class="subdued">chrome.bookmarks.</span><span>onMoved</spa n><span class="subdued">.addListener</span>(function(<span>string id, object mov eInfo</span>) <span class="subdued">{...}</span><span></span>);
2156 </div>
2157 <div class="description">
2158 <p>Fired when a bookmark or folder is moved to a different paren t folder.</p>
2159 <!-- LISTENER PARAMETERS -->
2160 <div>
2161 <h4>Listener parameters</h4>
2162 <dl>
2163 <div>
2164 <div>
2165 <dt>
2166 <var>id</var>
2167 <em>
2168 <!-- TYPE -->
2169 <div style="display:inline">
2170 (
2171 <span id="typeTemplate">
2172 <span>
2173 <span>string</span>
2174 </span>
2175 </span>
2176 )
2177 </div>
2178 </em>
2179 </dt>
2180 <dd class="todo">
2181 Undocumented.
2182 </dd>
2183 <!-- OBJECT PROPERTIES -->
2184 <!-- OBJECT METHODS -->
2185 <!-- OBJECT EVENT FIELDS -->
2186 <!-- FUNCTION PARAMETERS -->
2187 </div>
2188 </div><div>
2189 <div>
2190 <dt>
2191 <var>moveInfo</var>
2192 <em>
2193 <!-- TYPE -->
2194 <div style="display:inline">
2195 (
2196 <span id="typeTemplate">
2197 <span>
2198 <span>object</span>
2199 </span>
2200 </span>
2201 )
2202 </div>
2203 </em>
2204 </dt>
2205 <dd class="todo">
2206 Undocumented.
2207 </dd>
2208 <!-- OBJECT PROPERTIES -->
2209 <dd>
2210 <dl>
2211 <div>
2212 <div>
2213 <dt>
2214 <var>parentId</var>
2215 <em>
2216 <!-- TYPE -->
2217 <div style="display:inline">
2218 (
2219 <span id="typeTemplate">
2220 <span>
2221 <span>string</span>
2222 </span>
2223 </span>
2224 )
2225 </div>
2226 </em>
2227 </dt>
2228 <dd class="todo">
2229 Undocumented.
2230 </dd>
2231 <!-- OBJECT PROPERTIES -->
2232 <!-- OBJECT METHODS -->
2233 <!-- OBJECT EVENT FIELDS -->
2234 <!-- FUNCTION PARAMETERS -->
2235 </div>
2236 </div><div>
2237 <div>
2238 <dt>
2239 <var>index</var>
2240 <em>
2241 <!-- TYPE -->
2242 <div style="display:inline">
2243 (
2244 <span id="typeTemplate">
2245 <span>
2246 <span>integer</span>
2247 </span>
2248 </span>
2249 )
2250 </div>
2251 </em>
2252 </dt>
2253 <dd class="todo">
2254 Undocumented.
2255 </dd>
2256 <!-- OBJECT PROPERTIES -->
2257 <!-- OBJECT METHODS -->
2258 <!-- OBJECT EVENT FIELDS -->
2259 <!-- FUNCTION PARAMETERS -->
2260 </div>
2261 </div><div>
2262 <div>
2263 <dt>
2264 <var>oldParentId</var>
2265 <em>
2266 <!-- TYPE -->
2267 <div style="display:inline">
2268 (
2269 <span id="typeTemplate">
2270 <span>
2271 <span>string</span>
2272 </span>
2273 </span>
2274 )
2275 </div>
2276 </em>
2277 </dt>
2278 <dd class="todo">
2279 Undocumented.
2280 </dd>
2281 <!-- OBJECT PROPERTIES -->
2282 <!-- OBJECT METHODS -->
2283 <!-- OBJECT EVENT FIELDS -->
2284 <!-- FUNCTION PARAMETERS -->
2285 </div>
2286 </div><div>
2287 <div>
2288 <dt>
2289 <var>oldIndex</var>
2290 <em>
2291 <!-- TYPE -->
2292 <div style="display:inline">
2293 (
2294 <span id="typeTemplate">
2295 <span>
2296 <span>integer</span>
2297 </span>
2298 </span>
2299 )
2300 </div>
2301 </em>
2302 </dt>
2303 <dd class="todo">
2304 Undocumented.
2305 </dd>
2306 <!-- OBJECT PROPERTIES -->
2307 <!-- OBJECT METHODS -->
2308 <!-- OBJECT EVENT FIELDS -->
2309 <!-- FUNCTION PARAMETERS -->
2310 </div>
2311 </div>
2312 </dl>
2313 </dd>
2314 <!-- OBJECT METHODS -->
2315 <!-- OBJECT EVENT FIELDS -->
2316 <!-- FUNCTION PARAMETERS -->
2317 </div>
2318 </div>
2319 </dl>
2320 </div>
2321 <!-- EXTRA PARAMETERS -->
2322 <!-- LISTENER RETURN VALUE -->
2323 <dl>
2324 </dl>
2325 </div> <!-- /description -->
2326 <!-- /description -->
2327 </div><div class="apiItem">
2328 <a name="event-onRemoved"></a>
2329 <h4>onRemoved</h4>
2330 <div class="summary">
2331 <!-- Note: intentionally longer 80 columns -->
2332 <span class="subdued">chrome.bookmarks.</span><span>onRemoved</s pan><span class="subdued">.addListener</span>(function(<span>string id, object r emoveInfo</span>) <span class="subdued">{...}</span><span></span>);
2333 </div>
2334 <div class="description">
2335 <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 fo r its contents.</p>
2336 <!-- LISTENER PARAMETERS -->
2337 <div>
2338 <h4>Listener parameters</h4>
2339 <dl>
2340 <div>
2341 <div>
2342 <dt>
2343 <var>id</var>
2344 <em>
2345 <!-- TYPE -->
2346 <div style="display:inline">
2347 (
2348 <span id="typeTemplate">
2349 <span>
2350 <span>string</span>
2351 </span>
2352 </span>
2353 )
2354 </div>
2355 </em>
2356 </dt>
2357 <dd class="todo">
2358 Undocumented.
2359 </dd>
2360 <!-- OBJECT PROPERTIES -->
2361 <!-- OBJECT METHODS -->
2362 <!-- OBJECT EVENT FIELDS -->
2363 <!-- FUNCTION PARAMETERS -->
2364 </div>
2365 </div><div>
2366 <div>
2367 <dt>
2368 <var>removeInfo</var>
2369 <em>
2370 <!-- TYPE -->
2371 <div style="display:inline">
2372 (
2373 <span id="typeTemplate">
2374 <span>
2375 <span>object</span>
2376 </span>
2377 </span>
2378 )
2379 </div>
2380 </em>
2381 </dt>
2382 <dd class="todo">
2383 Undocumented.
2384 </dd>
2385 <!-- OBJECT PROPERTIES -->
2386 <dd>
2387 <dl>
2388 <div>
2389 <div>
2390 <dt>
2391 <var>parentId</var>
2392 <em>
2393 <!-- TYPE -->
2394 <div style="display:inline">
2395 (
2396 <span id="typeTemplate">
2397 <span>
2398 <span>string</span>
2399 </span>
2400 </span>
2401 )
2402 </div>
2403 </em>
2404 </dt>
2405 <dd class="todo">
2406 Undocumented.
2407 </dd>
2408 <!-- OBJECT PROPERTIES -->
2409 <!-- OBJECT METHODS -->
2410 <!-- OBJECT EVENT FIELDS -->
2411 <!-- FUNCTION PARAMETERS -->
2412 </div>
2413 </div><div>
2414 <div>
2415 <dt>
2416 <var>index</var>
2417 <em>
2418 <!-- TYPE -->
2419 <div style="display:inline">
2420 (
2421 <span id="typeTemplate">
2422 <span>
2423 <span>integer</span>
2424 </span>
2425 </span>
2426 )
2427 </div>
2428 </em>
2429 </dt>
2430 <dd class="todo">
2431 Undocumented.
2432 </dd>
2433 <!-- OBJECT PROPERTIES -->
2434 <!-- OBJECT METHODS -->
2435 <!-- OBJECT EVENT FIELDS -->
2436 <!-- FUNCTION PARAMETERS -->
2437 </div>
2438 </div>
2439 </dl>
2440 </dd>
2441 <!-- OBJECT METHODS -->
2442 <!-- OBJECT EVENT FIELDS -->
2443 <!-- FUNCTION PARAMETERS -->
2444 </div>
2445 </div>
2446 </dl>
2447 </div>
2448 <!-- EXTRA PARAMETERS -->
2449 <!-- LISTENER RETURN VALUE -->
2450 <dl>
2451 </dl>
2452 </div> <!-- /description -->
2453 <!-- /description -->
2454 </div> <!-- /apiItem -->
2455 </div> <!-- /apiGroup -->
2456 <!-- TYPES -->
2457 <div class="apiGroup">
2458 <a name="types"></a>
2459 <h3 id="types">Types</h3>
2460 <!-- iterates over all types -->
2461 <div class="apiItem">
2462 <a name="type-BookmarkTreeNode"></a>
2463 <h4>BookmarkTreeNode</h4>
2464 <div>
2465 <dt>
2466 <em>
2467 <!-- TYPE -->
2468 <div style="display:inline">
2469 (
2470 <span id="typeTemplate">
2471 <span>
2472 <span>object</span>
2473 </span>
2474 </span>
2475 )
2476 </div>
2477 </em>
2478 </dt>
2479 <dd>A node (either a bookmark or a folder) in the bookmark tree. Chil d nodes are ordered within their parent folder.</dd>
2480 <!-- OBJECT PROPERTIES -->
2481 <dd>
2482 <dl>
2483 <div>
2484 <div>
2485 <dt>
2486 <var>id</var>
2487 <em>
2488 <!-- TYPE -->
2489 <div style="display:inline">
2490 (
2491 <span id="typeTemplate">
2492 <span>
2493 <span>string</span>
2494 </span>
2495 </span>
2496 )
2497 </div>
2498 </em>
2499 </dt>
2500 <dd>The unique identifier for the node. IDs are unique within the curr ent profile, and they remain valid even after the browser is restarted.</dd>
2501 <!-- OBJECT PROPERTIES -->
2502 <!-- OBJECT METHODS -->
2503 <!-- OBJECT EVENT FIELDS -->
2504 <!-- FUNCTION PARAMETERS -->
2505 </div>
2506 </div><div>
2507 <div>
2508 <dt>
2509 <var>parentId</var>
2510 <em>
2511 <!-- TYPE -->
2512 <div style="display:inline">
2513 (
2514 <span class="optional">optional</span>
2515 <span id="typeTemplate">
2516 <span>
2517 <span>string</span>
2518 </span>
2519 </span>
2520 )
2521 </div>
2522 </em>
2523 </dt>
2524 <dd>The <code>id</code> of the parent folder. Omitted for the root no de.</dd>
2525 <!-- OBJECT PROPERTIES -->
2526 <!-- OBJECT METHODS -->
2527 <!-- OBJECT EVENT FIELDS -->
2528 <!-- FUNCTION PARAMETERS -->
2529 </div>
2530 </div><div>
2531 <div>
2532 <dt>
2533 <var>index</var>
2534 <em>
2535 <!-- TYPE -->
2536 <div style="display:inline">
2537 (
2538 <span class="optional">optional</span>
2539 <span id="typeTemplate">
2540 <span>
2541 <span>integer</span>
2542 </span>
2543 </span>
2544 )
2545 </div>
2546 </em>
2547 </dt>
2548 <dd>The 0-based position of this node within its parent folder.</dd>
2549 <!-- OBJECT PROPERTIES -->
2550 <!-- OBJECT METHODS -->
2551 <!-- OBJECT EVENT FIELDS -->
2552 <!-- FUNCTION PARAMETERS -->
2553 </div>
2554 </div><div>
2555 <div>
2556 <dt>
2557 <var>url</var>
2558 <em>
2559 <!-- TYPE -->
2560 <div style="display:inline">
2561 (
2562 <span class="optional">optional</span>
2563 <span id="typeTemplate">
2564 <span>
2565 <span>string</span>
2566 </span>
2567 </span>
2568 )
2569 </div>
2570 </em>
2571 </dt>
2572 <dd>The URL navigated to when a user clicks the bookmark. Omitted for folders.</dd>
2573 <!-- OBJECT PROPERTIES -->
2574 <!-- OBJECT METHODS -->
2575 <!-- OBJECT EVENT FIELDS -->
2576 <!-- FUNCTION PARAMETERS -->
2577 </div>
2578 </div><div>
2579 <div>
2580 <dt>
2581 <var>title</var>
2582 <em>
2583 <!-- TYPE -->
2584 <div style="display:inline">
2585 (
2586 <span id="typeTemplate">
2587 <span>
2588 <span>string</span>
2589 </span>
2590 </span>
2591 )
2592 </div>
2593 </em>
2594 </dt>
2595 <dd>The text displayed for the node.</dd>
2596 <!-- OBJECT PROPERTIES -->
2597 <!-- OBJECT METHODS -->
2598 <!-- OBJECT EVENT FIELDS -->
2599 <!-- FUNCTION PARAMETERS -->
2600 </div>
2601 </div><div>
2602 <div>
2603 <dt>
2604 <var>dateAdded</var>
2605 <em>
2606 <!-- TYPE -->
2607 <div style="display:inline">
2608 (
2609 <span class="optional">optional</span>
2610 <span id="typeTemplate">
2611 <span>
2612 <span>number</span>
2613 </span>
2614 </span>
2615 )
2616 </div>
2617 </em>
2618 </dt>
2619 <dd>When this node was created, in milliseconds since the epoch (<code >new Date(dateAdded)</code>).</dd>
2620 <!-- OBJECT PROPERTIES -->
2621 <!-- OBJECT METHODS -->
2622 <!-- OBJECT EVENT FIELDS -->
2623 <!-- FUNCTION PARAMETERS -->
2624 </div>
2625 </div><div>
2626 <div>
2627 <dt>
2628 <var>dateGroupModified</var>
2629 <em>
2630 <!-- TYPE -->
2631 <div style="display:inline">
2632 (
2633 <span class="optional">optional</span>
2634 <span id="typeTemplate">
2635 <span>
2636 <span>number</span>
2637 </span>
2638 </span>
2639 )
2640 </div>
2641 </em>
2642 </dt>
2643 <dd>When the contents of this folder last changed, in milliseconds sin ce the epoch.</dd>
2644 <!-- OBJECT PROPERTIES -->
2645 <!-- OBJECT METHODS -->
2646 <!-- OBJECT EVENT FIELDS -->
2647 <!-- FUNCTION PARAMETERS -->
2648 </div>
2649 </div><div>
2650 <div>
2651 <dt>
2652 <var>children</var>
2653 <em>
2654 <!-- TYPE -->
2655 <div style="display:inline">
2656 (
2657 <span class="optional">optional</span>
2658 <span id="typeTemplate">
2659 <span>
2660 <span>
2661 array of <span><span>
2662 <span>
2663 <a href="bookmarks.html#type-BookmarkTreeNode">BookmarkT reeNode</a>
2664 </span>
2665 </span></span>
2666 </span>
2667 </span>
2668 </span>
2669 )
2670 </div>
2671 </em>
2672 </dt>
2673 <dd>An ordered list of children of this node.</dd>
2674 <!-- OBJECT PROPERTIES -->
2675 <!-- OBJECT METHODS -->
2676 <!-- OBJECT EVENT FIELDS -->
2677 <!-- FUNCTION PARAMETERS -->
2678 </div>
2679 </div>
2680 </dl>
2681 </dd>
2682 <!-- OBJECT METHODS -->
2683 <!-- OBJECT EVENT FIELDS -->
2684 <!-- FUNCTION PARAMETERS -->
2685 </div>
2686 </div> <!-- /apiItem -->
2687 </div> <!-- /apiGroup -->
2688 </div> <!-- /apiPage -->
2689 </div> <!-- /gc-pagecontent -->
2690 </div> <!-- /g-section -->
2691 </div> <!-- /codesiteContent -->
2692 <div id="gc-footer" --="">
2693 <div class="text">
2694 <p>
2695 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
2696 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
2697 Attribution 3.0 License</a>, and code samples are licensed under the
2698 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
2699 </p>
2700 <p>
2701 ©2011 Google
2702 </p>
2703 <!-- begin analytics -->
2704 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
2705 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
2706 <script type="text/javascript">
2707 // chrome doc tracking
2708 try {
2709 var engdocs = _gat._getTracker("YT-10763712-2");
2710 engdocs._trackPageview();
2711 } catch(err) {}
2712 // code.google.com site-wide tracking
2713 try {
2714 _uacct="UA-18071-1";
2715 _uanchor=1;
2716 _uff=0;
2717 urchinTracker();
2718 }
2719 catch(e) {/* urchinTracker not available. */}
2720 </script>
2721 <!-- end analytics -->
2722 </div>
2723 </div> <!-- /gc-footer -->
2724 </div> <!-- /gc-container -->
2725 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/background_pages.html ('k') | chrome/common/extensions/docs/browserAction.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698