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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.storage.html

Issue 9274004: Take the Extension Storage API out of experimental. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: . Created 8 years, 11 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/experimental.html ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 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 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 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 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 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 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"> 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script> 15 </script>
16 <script type="text/javascript" src="js/api_page_generator.js"></script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script>
17 <script type="text/javascript" src="js/bootstrap.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script>
18 <script type="text/javascript" src="js/sidebar.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script>
19 <meta name="description" content="Documentation for the chrome.experimental.st orage module, which is part of the Google Chrome extension APIs."><title>chrome .experimental.storage - Google Chrome Extensions - Google Code</title></head> 19 <title>experimental.storage - Google Chrome Extensions - Google Code</title></ head>
20 <body> <div id="gc-container" class="labs"> 20 <body> <div id="gc-container" class="labs">
21 <div id="devModeWarning"> 21 <div id="devModeWarning">
22 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. 22 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.
23 </div> 23 </div>
24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
25 <!-- In particular, sub-templates that recurse, must be used by allowing 25 <!-- In particular, sub-templates that recurse, must be used by allowing
26 jstemplate to make a copy of the template in this section which 26 jstemplate to make a copy of the template in this section which
27 are not operated on by way of the jsskip="true" --> 27 are not operated on by way of the jsskip="true" -->
28 <div style="display:none"> 28 <div style="display:none">
29 29
(...skipping 258 matching lines...) Expand 10 before | Expand all | Expand 10 after
288 </ul> 288 </ul>
289 </li> 289 </li>
290 </ul> 290 </ul>
291 </div> 291 </div>
292 <script> 292 <script>
293 initToggles(); 293 initToggles();
294 </script> 294 </script>
295 295
296 <div class="g-unit" id="gc-pagecontent"> 296 <div class="g-unit" id="gc-pagecontent">
297 <div id="pageTitle"> 297 <div id="pageTitle">
298 <h1 class="page_title">chrome.experimental.storage</h1> 298 <h1 class="page_title">experimental.storage</h1>
299 </div> 299 </div>
300 <!-- TABLE OF CONTENTS --> 300 <!-- TABLE OF CONTENTS -->
301 <div id="toc"> 301 <div id="toc" style="display: none; ">
302 <h2>Contents</h2> 302 <h2>Contents</h2>
303 <ol> 303 <ol>
304 <li style="display: none; "> 304 <li>
305 <a>h2Name</a> 305 <a>h2Name</a>
306 <ol> 306 <ol>
307 <li> 307 <li>
308 <a>h3Name</a> 308 <a>h3Name</a>
309 </li> 309 </li>
310 </ol> 310 </ol>
311 </li> 311 </li>
312 <li> 312 <li>
313 <a href="#apiReference">API reference: chrome.experimental.stora ge</a> 313 <a href="#apiReference">API reference</a>
314 <ol> 314 <ol>
315 <li> 315 <div></div>
316 <a href="#properties">Properties</a> 316 <div></div>
317 <ol> 317 <div></div>
318 <li> 318 <div></div>
319 <a href="#property-sync">sync</a>
320 </li><li>
321 <a href="#property-local">local</a>
322 </li>
323 </ol>
324 </li>
325 <li style="display: none; ">
326 <a>Methods</a>
327 <ol>
328 <li>
329 <a href="#method-anchor">methodName</a>
330 </li>
331 </ol>
332 </li>
333 <li>
334 <a href="#global-events">Events</a>
335 <ol>
336 <li>
337 <a href="#event-onChanged">onChanged</a>
338 </li>
339 </ol>
340 </li>
341 <li>
342 <a href="#types">Types</a>
343 <ol>
344 <li>
345 <a href="#type-StorageChange">StorageChange</a>
346 <ol>
347 <li style="display: none; ">
348 <a>Methods</a>
349 <ol>
350 <li>
351 <a href="#method-anchor">methodName</a>
352 </li>
353 </ol>
354 </li>
355 <li style="display: none; ">
356 <a>Events</a>
357 <ol>
358 <li>
359 <a href="#event-anchor">eventName</a>
360 </li>
361 </ol>
362 </li>
363 </ol>
364 </li><li>
365 <a href="#type-StorageNamespace">StorageNamespace</a>
366 <ol>
367 <li>
368 <a href="#global-StorageNamespace-methods">Methods</a>
369 <ol>
370 <li>
371 <a href="#method-StorageNamespace-clear">clear</a>
372 </li><li>
373 <a href="#method-StorageNamespace-get">get</a>
374 </li><li>
375 <a href="#method-StorageNamespace-remove">remove</a>
376 </li><li>
377 <a href="#method-StorageNamespace-set">set</a>
378 </li>
379 </ol>
380 </li>
381 <li style="display: none; ">
382 <a>Events</a>
383 <ol>
384 <li>
385 <a href="#event-anchor">eventName</a>
386 </li>
387 </ol>
388 </li>
389 </ol>
390 </li>
391 </ol>
392 </li>
393 </ol> 319 </ol>
394 </li> 320 </li>
395 </ol> 321 </ol>
396 </div> 322 </div>
397 <!-- /TABLE OF CONTENTS --> 323 <!-- /TABLE OF CONTENTS -->
398 324
399 <!-- Standard content lead-in for experimental API pages --> 325 <!-- Standard content lead-in for experimental API pages -->
400 <p id="classSummary"> 326 <p id="classSummary" style="display: none; ">
401 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page. 327 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
402 </p> 328 </p>
403 329
404 <!-- STATIC CONTENT PLACEHOLDER --> 330 <!-- STATIC CONTENT PLACEHOLDER -->
405 <div id="static"></div> 331 <div id="static"><div id="pageData-name" class="pageData">experimental.s torage</div>
332
333 <p>
334 The <code>Storage</code> API is no longer experimental;
335 it's supported! You can read all about it at its new home:
336 </p>
337
338 <blockquote>
339 <a href="storage.html">chrome.storage</a>
340 </blockquote>
341 </div>
406 342
407 <!-- API PAGE --> 343 <!-- API PAGE -->
408 <div class="apiPage"> 344 <div class="apiPage" style="display: none; ">
409 <a name="apiReference"></a> 345 <a name="apiReference"></a>
410 <h2>API reference: chrome.experimental.storage</h2> 346 <h2>API reference: chrome.apiname </h2>
411 347
412 <!-- PROPERTIES --> 348 <!-- PROPERTIES -->
413 <div class="apiGroup"> 349 <div class="apiGroup">
414 <a name="properties"></a> 350 <a name="properties"></a>
415 <h3 id="properties">Properties</h3> 351 <h3 id="properties">Properties</h3>
416 352
417 <div> 353 <div>
418 <a name="property-sync"></a> 354 <a></a>
419 <h4>sync</h4> 355 <h4>getLastError</h4>
420 <div class="summary"> 356 <div class="summary">
421 <!-- Note: intentionally longer 80 columns --> 357 <!-- Note: intentionally longer 80 columns -->
422 <span>chrome.experimental.storage.</span><span>sync</span> 358 <span>chrome.extension</span><span>lastError</span>
423 </div> 359 </div>
424 <div> 360 <div>
425 <dt>
426 <var>sync</var>
427 <em>
428
429 <!-- TYPE -->
430 <div style="display:inline">
431 (
432 <span class="optional" style="display: none; ">optional</spa n>
433 <span class="enum" style="display: none; ">enumerated</span>
434 <span id="typeTemplate">
435 <span>
436 <a href="experimental.storage.html#type-StorageNamespace ">StorageNamespace</a>
437 </span>
438 <span style="display: none; ">
439 <span>
440 array of <span><span></span></span>
441 </span>
442 <span>paramType</span>
443 <span></span>
444 </span>
445 </span>
446 )
447 </div>
448
449 </em>
450 </dt>
451 <dd class="todo" style="display: none; ">
452 Undocumented.
453 </dd>
454 <dd>Items under the "sync" namespace are synced using Chrome Sync.</dd >
455 <dd style="display: none; ">
456 This parameter was added in version
457 <b><span></span></b>.
458 You must omit this parameter in earlier versions,
459 and you may omit it in any version. If you require this
460 parameter, the manifest key
461 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
462 can ensure that your extension won't be run in an earlier browser ve rsion.
463 </dd>
464
465 <!-- OBJECT PROPERTIES -->
466 <dd style="display: none; ">
467 <dl>
468 <div>
469 <div>
470 </div>
471 </div> 361 </div>
472 </dl>
473 </dd>
474
475 <!-- OBJECT METHODS -->
476 <dd style="display: none; ">
477 <div></div>
478 </dd>
479
480 <!-- OBJECT EVENT FIELDS -->
481 <dd style="display: none; ">
482 <div></div>
483 </dd>
484
485 <!-- FUNCTION PARAMETERS -->
486 <dd style="display: none; ">
487 <div></div>
488 </dd>
489
490 </div>
491 </div><div>
492 <a name="property-local"></a>
493 <h4>local</h4>
494 <div class="summary">
495 <!-- Note: intentionally longer 80 columns -->
496 <span>chrome.experimental.storage.</span><span>local</span>
497 </div>
498 <div>
499 <dt>
500 <var>local</var>
501 <em>
502
503 <!-- TYPE -->
504 <div style="display:inline">
505 (
506 <span class="optional" style="display: none; ">optional</spa n>
507 <span class="enum" style="display: none; ">enumerated</span>
508 <span id="typeTemplate">
509 <span>
510 <a href="experimental.storage.html#type-StorageNamespace ">StorageNamespace</a>
511 </span>
512 <span style="display: none; ">
513 <span>
514 array of <span><span></span></span>
515 </span>
516 <span>paramType</span>
517 <span></span>
518 </span>
519 </span>
520 )
521 </div>
522
523 </em>
524 </dt>
525 <dd class="todo" style="display: none; ">
526 Undocumented.
527 </dd>
528 <dd>Items under the "local" namespace are local to each machine.</dd>
529 <dd style="display: none; ">
530 This parameter was added in version
531 <b><span></span></b>.
532 You must omit this parameter in earlier versions,
533 and you may omit it in any version. If you require this
534 parameter, the manifest key
535 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
536 can ensure that your extension won't be run in an earlier browser ve rsion.
537 </dd>
538
539 <!-- OBJECT PROPERTIES -->
540 <dd style="display: none; ">
541 <dl>
542 <div>
543 <div>
544 </div>
545 </div>
546 </dl>
547 </dd>
548
549 <!-- OBJECT METHODS -->
550 <dd style="display: none; ">
551 <div></div>
552 </dd>
553
554 <!-- OBJECT EVENT FIELDS -->
555 <dd style="display: none; ">
556 <div></div>
557 </dd>
558
559 <!-- FUNCTION PARAMETERS -->
560 <dd style="display: none; ">
561 <div></div>
562 </dd>
563
564 </div>
565 </div> 362 </div>
566 363
567 </div> <!-- /apiGroup --> 364 </div> <!-- /apiGroup -->
568 365
569 <!-- METHODS --> 366 <!-- METHODS -->
570 <div id="methodsTemplate" class="apiGroup" style="display: none; "> 367 <div id="methodsTemplate" class="apiGroup">
571 <a></a> 368 <a></a>
572 <h3>Methods</h3> 369 <h3>Methods</h3>
573 370
574 <!-- iterates over all functions --> 371 <!-- iterates over all functions -->
575 <div class="apiItem"> 372 <div class="apiItem">
576 <a></a> <!-- method-anchor --> 373 <a></a> <!-- method-anchor -->
577 <h4>method name</h4> 374 <h4>method name</h4>
578 375
579 <div class="summary"><span>void</span> 376 <div class="summary"><span>void</span>
580 <!-- Note: intentionally longer 80 columns --> 377 <!-- Note: intentionally longer 80 columns -->
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after
637 can ensure that your extension won't be run in an earlier brow ser version. 434 can ensure that your extension won't be run in an earlier brow ser version.
638 </p> 435 </p>
639 </div> <!-- /description --> 436 </div> <!-- /description -->
640 437
641 </div> <!-- /apiItem --> 438 </div> <!-- /apiItem -->
642 439
643 </div> <!-- /apiGroup --> 440 </div> <!-- /apiGroup -->
644 441
645 <!-- EVENTS --> 442 <!-- EVENTS -->
646 <div id="eventsTemplate" class="apiGroup"> 443 <div id="eventsTemplate" class="apiGroup">
647 <a name="global-events"></a> 444 <a></a>
648 <h3>Events</h3> 445 <h3>Events</h3>
649 <!-- iterates over all events --> 446 <!-- iterates over all events -->
650 <div class="apiItem"> 447 <div class="apiItem">
651 <a name="event-onChanged"></a> 448 <a></a>
652 <h4>onChanged</h4> 449 <h4>event name</h4>
653 450
654 <div class="summary"> 451 <div class="summary">
655 <!-- Note: intentionally longer 80 columns --> 452 <!-- Note: intentionally longer 80 columns -->
656 <span class="subdued">chrome.experimental.storage.</span><span>o nChanged</span><span class="subdued">.addListener</span>(function(<span>object c hanges, string namespace</span>) <span class="subdued">{...}</span><span></span> ); 453 <span class="subdued">chrome.bookmarks</span><span>onEvent</span ><span class="subdued">.addListener</span>(function(<span>Type param1, Type para m2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_p aram2</span>);
657 </div> 454 </div>
658 455
659 <div class="description"> 456 <div class="description">
660 <p class="todo" style="display: none; ">Undocumented.</p> 457 <p class="todo">Undocumented.</p>
661 <p>Fired when one or more items change.</p> 458 <p>
459 A description from the json schema def of the event goes here.
460 </p>
662 461
663 <!-- LISTENER PARAMETERS --> 462 <!-- LISTENER PARAMETERS -->
664 <div> 463 <div>
665 <h4>Listener parameters</h4> 464 <h4>Listener parameters</h4>
666 <dl> 465 <dl>
667 <div> 466 <div>
668 <div> 467 <div>
669 <dt> 468 </div>
670 <var>changes</var>
671 <em>
672
673 <!-- TYPE -->
674 <div style="display:inline">
675 (
676 <span class="optional" style="display: none; ">optional</spa n>
677 <span class="enum" style="display: none; ">enumerated</span>
678 <span id="typeTemplate">
679 <span style="display: none; ">
680 <a> Type</a>
681 </span>
682 <span>
683 <span style="display: none; ">
684 array of <span><span></span></span>
685 </span>
686 <span>object</span>
687 <span style="display: none; "></span>
688 </span>
689 </span>
690 )
691 </div>
692
693 </em>
694 </dt>
695 <dd class="todo" style="display: none; ">
696 Undocumented.
697 </dd>
698 <dd>Object mapping each key that changed to its corresponding <a href= "#type-StorageChange">StorageChange</a> for that item.</dd>
699 <dd style="display: none; ">
700 This parameter was added in version
701 <b><span></span></b>.
702 You must omit this parameter in earlier versions,
703 and you may omit it in any version. If you require this
704 parameter, the manifest key
705 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
706 can ensure that your extension won't be run in an earlier browser ve rsion.
707 </dd>
708
709 <!-- OBJECT PROPERTIES -->
710 <dd>
711 <dl>
712 <div style="display: none; ">
713 <div>
714 </div>
715 </div>
716 </dl>
717 </dd>
718
719 <!-- OBJECT METHODS -->
720 <dd style="display: none; ">
721 <div></div>
722 </dd>
723
724 <!-- OBJECT EVENT FIELDS -->
725 <dd style="display: none; ">
726 <div></div>
727 </dd>
728
729 <!-- FUNCTION PARAMETERS -->
730 <dd style="display: none; ">
731 <div></div>
732 </dd>
733
734 </div>
735 </div><div>
736 <div>
737 <dt>
738 <var>namespace</var>
739 <em>
740
741 <!-- TYPE -->
742 <div style="display:inline">
743 (
744 <span class="optional" style="display: none; ">optional</spa n>
745 <span class="enum" style="display: none; ">enumerated</span>
746 <span id="typeTemplate">
747 <span style="display: none; ">
748 <a> Type</a>
749 </span>
750 <span>
751 <span style="display: none; ">
752 array of <span><span></span></span>
753 </span>
754 <span>string</span>
755 <span style="display: none; "></span>
756 </span>
757 </span>
758 )
759 </div>
760
761 </em>
762 </dt>
763 <dd class="todo" style="display: none; ">
764 Undocumented.
765 </dd>
766 <dd>The namespace ("sync" or "local") of the storage area the changes are for.</dd>
767 <dd style="display: none; ">
768 This parameter was added in version
769 <b><span></span></b>.
770 You must omit this parameter in earlier versions,
771 and you may omit it in any version. If you require this
772 parameter, the manifest key
773 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
774 can ensure that your extension won't be run in an earlier browser ve rsion.
775 </dd>
776
777 <!-- OBJECT PROPERTIES -->
778 <dd style="display: none; ">
779 <dl>
780 <div>
781 <div>
782 </div>
783 </div>
784 </dl>
785 </dd>
786
787 <!-- OBJECT METHODS -->
788 <dd style="display: none; ">
789 <div></div>
790 </dd>
791
792 <!-- OBJECT EVENT FIELDS -->
793 <dd style="display: none; ">
794 <div></div>
795 </dd>
796
797 <!-- FUNCTION PARAMETERS -->
798 <dd style="display: none; ">
799 <div></div>
800 </dd>
801
802 </div>
803 </div> 469 </div>
804 </dl> 470 </dl>
805 </div> 471 </div>
806 472
807 <!-- EXTRA PARAMETERS --> 473 <!-- EXTRA PARAMETERS -->
808 <div style="display: none; "> 474 <div>
809 <h4>Extra parameters to addListener</h4> 475 <h4>Extra parameters to addListener</h4>
810 <dl> 476 <dl>
811 <div> 477 <div>
812 <div> 478 <div>
813 </div> 479 </div>
814 </div> 480 </div>
815 </dl> 481 </dl>
816 </div> 482 </div>
817 483
818 <!-- LISTENER RETURN VALUE --> 484 <!-- LISTENER RETURN VALUE -->
819 <h4 style="display: none; ">Listener returns</h4> 485 <h4>Listener returns</h4>
820 <dl> 486 <dl>
821 <div style="display: none; "> 487 <div>
822 <div> 488 <div>
823 </div> 489 </div>
824 </div> 490 </div>
825 </dl> 491 </dl>
826 492
827 </div> <!-- /description --> 493 </div> <!-- /description -->
828 </div> <!-- /apiItem --> 494 </div> <!-- /apiItem -->
829 495
830 </div> <!-- /apiGroup --> 496 </div> <!-- /apiGroup -->
831 497
832 <!-- TYPES --> 498 <!-- TYPES -->
833 <div class="apiGroup"> 499 <div class="apiGroup">
834 <a name="types"></a> 500 <a name="types"></a>
835 <h3 id="types">Types</h3> 501 <h3 id="types">Types</h3>
836 502
837 <!-- iterates over all types --> 503 <!-- iterates over all types -->
838 <div class="apiItem"> 504 <div class="apiItem">
839 <a name="type-StorageChange"></a> 505 <a></a>
840 <h4>StorageChange</h4> 506 <h4>type name</h4>
841 507
842 <div> 508 <div>
843 <dt>
844 <var style="display: none; ">paramName</var>
845 <em>
846
847 <!-- TYPE -->
848 <div style="display:inline">
849 (
850 <span class="optional" style="display: none; ">optional</spa n>
851 <span class="enum" style="display: none; ">enumerated</span>
852 <span id="typeTemplate">
853 <span style="display: none; ">
854 <a> Type</a>
855 </span>
856 <span>
857 <span style="display: none; ">
858 array of <span><span></span></span>
859 </span>
860 <span>object</span>
861 <span style="display: none; "></span>
862 </span>
863 </span>
864 )
865 </div>
866
867 </em>
868 </dt>
869 <dd class="todo">
870 Undocumented.
871 </dd>
872 <dd style="display: none; ">
873 Description of this parameter from the json schema.
874 </dd>
875 <dd style="display: none; ">
876 This parameter was added in version
877 <b><span></span></b>.
878 You must omit this parameter in earlier versions,
879 and you may omit it in any version. If you require this
880 parameter, the manifest key
881 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
882 can ensure that your extension won't be run in an earlier browser ve rsion.
883 </dd>
884
885 <!-- OBJECT PROPERTIES -->
886 <dd>
887 <dl>
888 <div>
889 <div>
890 <dt>
891 <var>oldValue</var>
892 <em>
893
894 <!-- TYPE -->
895 <div style="display:inline">
896 (
897 <span class="optional">optional</span>
898 <span class="enum" style="display: none; ">enumerated</span>
899 <span id="typeTemplate">
900 <span style="display: none; ">
901 <a> Type</a>
902 </span>
903 <span>
904 <span style="display: none; ">
905 array of <span><span></span></span>
906 </span>
907 <span>any</span>
908 <span style="display: none; "></span>
909 </span>
910 </span>
911 )
912 </div>
913
914 </em>
915 </dt>
916 <dd class="todo" style="display: none; ">
917 Undocumented.
918 </dd>
919 <dd>The old value of the item, if there was an old value.</dd>
920 <dd style="display: none; ">
921 This parameter was added in version
922 <b><span></span></b>.
923 You must omit this parameter in earlier versions,
924 and you may omit it in any version. If you require this
925 parameter, the manifest key
926 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
927 can ensure that your extension won't be run in an earlier browser ve rsion.
928 </dd>
929
930 <!-- OBJECT PROPERTIES -->
931 <dd style="display: none; ">
932 <dl>
933 <div>
934 <div>
935 </div>
936 </div> 509 </div>
937 </dl>
938 </dd>
939
940 <!-- OBJECT METHODS -->
941 <dd style="display: none; ">
942 <div></div>
943 </dd>
944
945 <!-- OBJECT EVENT FIELDS -->
946 <dd style="display: none; ">
947 <div></div>
948 </dd>
949
950 <!-- FUNCTION PARAMETERS -->
951 <dd style="display: none; ">
952 <div></div>
953 </dd>
954
955 </div>
956 </div><div>
957 <div>
958 <dt>
959 <var>newValue</var>
960 <em>
961
962 <!-- TYPE -->
963 <div style="display:inline">
964 (
965 <span class="optional">optional</span>
966 <span class="enum" style="display: none; ">enumerated</span>
967 <span id="typeTemplate">
968 <span style="display: none; ">
969 <a> Type</a>
970 </span>
971 <span>
972 <span style="display: none; ">
973 array of <span><span></span></span>
974 </span>
975 <span>any</span>
976 <span style="display: none; "></span>
977 </span>
978 </span>
979 )
980 </div>
981
982 </em>
983 </dt>
984 <dd class="todo" style="display: none; ">
985 Undocumented.
986 </dd>
987 <dd>The new value of the item, if there is a new value.</dd>
988 <dd style="display: none; ">
989 This parameter was added in version
990 <b><span></span></b>.
991 You must omit this parameter in earlier versions,
992 and you may omit it in any version. If you require this
993 parameter, the manifest key
994 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
995 can ensure that your extension won't be run in an earlier browser ve rsion.
996 </dd>
997
998 <!-- OBJECT PROPERTIES -->
999 <dd style="display: none; ">
1000 <dl>
1001 <div>
1002 <div>
1003 </div>
1004 </div>
1005 </dl>
1006 </dd>
1007
1008 <!-- OBJECT METHODS -->
1009 <dd style="display: none; ">
1010 <div></div>
1011 </dd>
1012
1013 <!-- OBJECT EVENT FIELDS -->
1014 <dd style="display: none; ">
1015 <div></div>
1016 </dd>
1017
1018 <!-- FUNCTION PARAMETERS -->
1019 <dd style="display: none; ">
1020 <div></div>
1021 </dd>
1022
1023 </div>
1024 </div>
1025 </dl>
1026 </dd>
1027
1028 <!-- OBJECT METHODS -->
1029 <dd style="display: none; ">
1030 <div></div>
1031 </dd>
1032
1033 <!-- OBJECT EVENT FIELDS -->
1034 <dd style="display: none; ">
1035 <div></div>
1036 </dd>
1037
1038 <!-- FUNCTION PARAMETERS -->
1039 <dd style="display: none; ">
1040 <div></div>
1041 </dd>
1042
1043 </div>
1044
1045 </div><div class="apiItem">
1046 <a name="type-StorageNamespace"></a>
1047 <h4>StorageNamespace</h4>
1048
1049 <div>
1050 <dt>
1051 <var style="display: none; ">paramName</var>
1052 <em>
1053
1054 <!-- TYPE -->
1055 <div style="display:inline">
1056 (
1057 <span class="optional" style="display: none; ">optional</spa n>
1058 <span class="enum" style="display: none; ">enumerated</span>
1059 <span id="typeTemplate">
1060 <span style="display: none; ">
1061 <a> Type</a>
1062 </span>
1063 <span>
1064 <span style="display: none; ">
1065 array of <span><span></span></span>
1066 </span>
1067 <span>object</span>
1068 <span style="display: none; "></span>
1069 </span>
1070 </span>
1071 )
1072 </div>
1073
1074 </em>
1075 </dt>
1076 <dd class="todo">
1077 Undocumented.
1078 </dd>
1079 <dd style="display: none; ">
1080 Description of this parameter from the json schema.
1081 </dd>
1082 <dd style="display: none; ">
1083 This parameter was added in version
1084 <b><span></span></b>.
1085 You must omit this parameter in earlier versions,
1086 and you may omit it in any version. If you require this
1087 parameter, the manifest key
1088 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1089 can ensure that your extension won't be run in an earlier browser ve rsion.
1090 </dd>
1091
1092 <!-- OBJECT PROPERTIES -->
1093 <dd style="display: none; ">
1094 <dl>
1095 <div>
1096 <div>
1097 </div>
1098 </div>
1099 </dl>
1100 </dd>
1101
1102 <!-- OBJECT METHODS -->
1103 <dd>
1104 <div class="apiGroup" style="">
1105 <a name="global-StorageNamespace-methods"></a>
1106 <h3>Methods of StorageNamespace</h3>
1107
1108 <!-- iterates over all functions -->
1109 <div class="apiItem">
1110 <a name="method-StorageNamespace-clear"></a> <!-- method-anchor -- >
1111 <h4>clear</h4>
1112
1113 <div class="summary"><span style="display: none; ">void</span>
1114 <!-- Note: intentionally longer 80 columns -->
1115 <span>storageNamespace.clear</span>(<span class="optional"><sp an style="display: none; ">, </span><span>function</span>
1116 <var><span>callback</span></var></span>)</div>
1117
1118 <div class="description">
1119 <p class="todo" style="display: none; ">Undocumented.</p>
1120 <p>Removes all items from storage.</p>
1121
1122 <!-- PARAMETERS -->
1123 <h4>Parameters</h4>
1124 <dl>
1125 <div>
1126 <div>
1127 <dt>
1128 <var>callback</var>
1129 <em>
1130
1131 <!-- TYPE -->
1132 <div style="display:inline">
1133 (
1134 <span class="optional">optional</span>
1135 <span class="enum" style="display: none; ">enumerated</span>
1136 <span id="typeTemplate">
1137 <span style="display: none; ">
1138 <a> Type</a>
1139 </span>
1140 <span>
1141 <span style="display: none; ">
1142 array of <span><span></span></span>
1143 </span>
1144 <span>function</span>
1145 <span style="display: none; "></span>
1146 </span>
1147 </span>
1148 )
1149 </div>
1150
1151 </em>
1152 </dt>
1153 <dd class="todo" style="display: none; ">
1154 Undocumented.
1155 </dd>
1156 <dd>Callback on success, or on failure (in which case lastError will b e set).</dd>
1157 <dd style="display: none; ">
1158 This parameter was added in version
1159 <b><span></span></b>.
1160 You must omit this parameter in earlier versions,
1161 and you may omit it in any version. If you require this
1162 parameter, the manifest key
1163 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1164 can ensure that your extension won't be run in an earlier browser ve rsion.
1165 </dd>
1166
1167 <!-- OBJECT PROPERTIES -->
1168 <dd style="display: none; ">
1169 <dl>
1170 <div>
1171 <div>
1172 </div>
1173 </div>
1174 </dl>
1175 </dd>
1176
1177 <!-- OBJECT METHODS -->
1178 <dd style="display: none; ">
1179 <div></div>
1180 </dd>
1181
1182 <!-- OBJECT EVENT FIELDS -->
1183 <dd style="display: none; ">
1184 <div></div>
1185 </dd>
1186
1187 <!-- FUNCTION PARAMETERS -->
1188 <dd style="display: none; ">
1189 <div></div>
1190 </dd>
1191
1192 </div>
1193 </div>
1194 </dl>
1195
1196 <!-- RETURNS -->
1197 <h4 style="display: none; ">Returns</h4>
1198 <dl>
1199 <div style="display: none; ">
1200 <div>
1201 </div>
1202 </div>
1203 </dl>
1204
1205 <!-- CALLBACK -->
1206 <div>
1207 <div>
1208 <h4>Callback function</h4>
1209 <p style="display: none; ">
1210 The callback <em>parameter</em> should specify a function
1211 that looks like this:
1212 </p>
1213 <p>
1214 If you specify the <em>callback</em> parameter, it should
1215 specify a function that looks like this:
1216 </p>
1217
1218 <!-- Note: intentionally longer 80 columns -->
1219 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1220 <dl>
1221 <div style="display: none; ">
1222 <div>
1223 </div>
1224 </div>
1225 </dl>
1226 </div>
1227 </div>
1228
1229 <!-- MIN_VERSION -->
1230 <p style="display: none; ">
1231 This function was added in version <b><span></span></b>.
1232 If you require this function, the manifest key
1233 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1234 can ensure that your extension won't be run in an earlier brow ser version.
1235 </p>
1236 </div> <!-- /description -->
1237
1238 </div><div class="apiItem">
1239 <a name="method-StorageNamespace-get"></a> <!-- method-anchor -->
1240 <h4>get</h4>
1241
1242 <div class="summary"><span style="display: none; ">void</span>
1243 <!-- Note: intentionally longer 80 columns -->
1244 <span>storageNamespace.get</span>(<span class="optional"><span style="display: none; ">, </span><span>string or array of string or object</spa n>
1245 <var><span>keys</span></var></span><span class="null"><spa n>, </span><span>function</span>
1246 <var><span>callback</span></var></span>)</div>
1247
1248 <div class="description">
1249 <p class="todo" style="display: none; ">Undocumented.</p>
1250 <p>Gets one or more items from storage.</p>
1251
1252 <!-- PARAMETERS -->
1253 <h4>Parameters</h4>
1254 <dl>
1255 <div>
1256 <div>
1257 <dt>
1258 <var>keys</var>
1259 <em>
1260
1261 <!-- TYPE -->
1262 <div style="display:inline">
1263 (
1264 <span class="optional">optional</span>
1265 <span class="enum" style="display: none; ">enumerated</span>
1266 <span id="typeTemplate">
1267 <span style="display: none; ">
1268 <a> Type</a>
1269 </span>
1270 <span>
1271 <span style="display: none; ">
1272 array of <span><span></span></span>
1273 </span>
1274 <span>string or array of string or object</span>
1275 <span style="display: none; "></span>
1276 </span>
1277 </span>
1278 )
1279 </div>
1280
1281 </em>
1282 </dt>
1283 <dd class="todo" style="display: none; ">
1284 Undocumented.
1285 </dd>
1286 <dd>A single key to get, list of keys to get, or a dictionary specifyi ng default values (see description of the object). An empty list or object will return an empty result object. Pass in null or undefined to get the entire con tents of storage; this should only be used for debugging.</dd>
1287 <dd style="display: none; ">
1288 This parameter was added in version
1289 <b><span></span></b>.
1290 You must omit this parameter in earlier versions,
1291 and you may omit it in any version. If you require this
1292 parameter, the manifest key
1293 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1294 can ensure that your extension won't be run in an earlier browser ve rsion.
1295 </dd>
1296
1297 <!-- OBJECT PROPERTIES -->
1298 <dd style="display: none; ">
1299 <dl>
1300 <div>
1301 <div>
1302 </div>
1303 </div>
1304 </dl>
1305 </dd>
1306
1307 <!-- OBJECT METHODS -->
1308 <dd style="display: none; ">
1309 <div></div>
1310 </dd>
1311
1312 <!-- OBJECT EVENT FIELDS -->
1313 <dd style="display: none; ">
1314 <div></div>
1315 </dd>
1316
1317 <!-- FUNCTION PARAMETERS -->
1318 <dd style="display: none; ">
1319 <div></div>
1320 </dd>
1321
1322 </div>
1323 </div><div>
1324 <div>
1325 <dt>
1326 <var>callback</var>
1327 <em>
1328
1329 <!-- TYPE -->
1330 <div style="display:inline">
1331 (
1332 <span class="optional" style="display: none; ">optional</spa n>
1333 <span class="enum" style="display: none; ">enumerated</span>
1334 <span id="typeTemplate">
1335 <span style="display: none; ">
1336 <a> Type</a>
1337 </span>
1338 <span>
1339 <span style="display: none; ">
1340 array of <span><span></span></span>
1341 </span>
1342 <span>function</span>
1343 <span style="display: none; "></span>
1344 </span>
1345 </span>
1346 )
1347 </div>
1348
1349 </em>
1350 </dt>
1351 <dd class="todo" style="display: none; ">
1352 Undocumented.
1353 </dd>
1354 <dd>Callback with storage items, or on failure (in which case lastErro r will be set).</dd>
1355 <dd style="display: none; ">
1356 This parameter was added in version
1357 <b><span></span></b>.
1358 You must omit this parameter in earlier versions,
1359 and you may omit it in any version. If you require this
1360 parameter, the manifest key
1361 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1362 can ensure that your extension won't be run in an earlier browser ve rsion.
1363 </dd>
1364
1365 <!-- OBJECT PROPERTIES -->
1366 <dd style="display: none; ">
1367 <dl>
1368 <div>
1369 <div>
1370 </div>
1371 </div>
1372 </dl>
1373 </dd>
1374
1375 <!-- OBJECT METHODS -->
1376 <dd style="display: none; ">
1377 <div></div>
1378 </dd>
1379
1380 <!-- OBJECT EVENT FIELDS -->
1381 <dd style="display: none; ">
1382 <div></div>
1383 </dd>
1384
1385 <!-- FUNCTION PARAMETERS -->
1386 <dd style="display: none; ">
1387 <div></div>
1388 </dd>
1389
1390 </div>
1391 </div>
1392 </dl>
1393
1394 <!-- RETURNS -->
1395 <h4 style="display: none; ">Returns</h4>
1396 <dl>
1397 <div style="display: none; ">
1398 <div>
1399 </div>
1400 </div>
1401 </dl>
1402
1403 <!-- CALLBACK -->
1404 <div>
1405 <div>
1406 <h4>Callback function</h4>
1407 <p>
1408 The callback <em>parameter</em> should specify a function
1409 that looks like this:
1410 </p>
1411 <p style="display: none; ">
1412 If you specify the <em>callback</em> parameter, it should
1413 specify a function that looks like this:
1414 </p>
1415
1416 <!-- Note: intentionally longer 80 columns -->
1417 <pre>function(<span>object items</span>) <span class="subdued" >{...}</span>;</pre>
1418 <dl>
1419 <div>
1420 <div>
1421 <dt>
1422 <var>items</var>
1423 <em>
1424
1425 <!-- TYPE -->
1426 <div style="display:inline">
1427 (
1428 <span class="optional" style="display: none; ">optional</spa n>
1429 <span class="enum" style="display: none; ">enumerated</span>
1430 <span id="typeTemplate">
1431 <span style="display: none; ">
1432 <a> Type</a>
1433 </span>
1434 <span>
1435 <span style="display: none; ">
1436 array of <span><span></span></span>
1437 </span>
1438 <span>object</span>
1439 <span style="display: none; "></span>
1440 </span>
1441 </span>
1442 )
1443 </div>
1444
1445 </em>
1446 </dt>
1447 <dd class="todo" style="display: none; ">
1448 Undocumented.
1449 </dd>
1450 <dd>Object with items in their key-value mappings.</dd>
1451 <dd style="display: none; ">
1452 This parameter was added in version
1453 <b><span></span></b>.
1454 You must omit this parameter in earlier versions,
1455 and you may omit it in any version. If you require this
1456 parameter, the manifest key
1457 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1458 can ensure that your extension won't be run in an earlier browser ve rsion.
1459 </dd>
1460
1461 <!-- OBJECT PROPERTIES -->
1462 <dd>
1463 <dl>
1464 <div style="display: none; ">
1465 <div>
1466 </div>
1467 </div>
1468 </dl>
1469 </dd>
1470
1471 <!-- OBJECT METHODS -->
1472 <dd style="display: none; ">
1473 <div></div>
1474 </dd>
1475
1476 <!-- OBJECT EVENT FIELDS -->
1477 <dd style="display: none; ">
1478 <div></div>
1479 </dd>
1480
1481 <!-- FUNCTION PARAMETERS -->
1482 <dd style="display: none; ">
1483 <div></div>
1484 </dd>
1485
1486 </div>
1487 </div>
1488 </dl>
1489 </div>
1490 </div>
1491
1492 <!-- MIN_VERSION -->
1493 <p style="display: none; ">
1494 This function was added in version <b><span></span></b>.
1495 If you require this function, the manifest key
1496 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1497 can ensure that your extension won't be run in an earlier brow ser version.
1498 </p>
1499 </div> <!-- /description -->
1500
1501 </div><div class="apiItem">
1502 <a name="method-StorageNamespace-remove"></a> <!-- method-anchor - ->
1503 <h4>remove</h4>
1504
1505 <div class="summary"><span style="display: none; ">void</span>
1506 <!-- Note: intentionally longer 80 columns -->
1507 <span>storageNamespace.remove</span>(<span class="null"><span style="display: none; ">, </span><span>string or array of string</span>
1508 <var><span>keys</span></var></span><span class="optional"> <span>, </span><span>function</span>
1509 <var><span>callback</span></var></span>)</div>
1510
1511 <div class="description">
1512 <p class="todo" style="display: none; ">Undocumented.</p>
1513 <p>Removes one or more items from storage.</p>
1514
1515 <!-- PARAMETERS -->
1516 <h4>Parameters</h4>
1517 <dl>
1518 <div>
1519 <div>
1520 <dt>
1521 <var>keys</var>
1522 <em>
1523
1524 <!-- TYPE -->
1525 <div style="display:inline">
1526 (
1527 <span class="optional" style="display: none; ">optional</spa n>
1528 <span class="enum" style="display: none; ">enumerated</span>
1529 <span id="typeTemplate">
1530 <span style="display: none; ">
1531 <a> Type</a>
1532 </span>
1533 <span>
1534 <span style="display: none; ">
1535 array of <span><span></span></span>
1536 </span>
1537 <span>string or array of string</span>
1538 <span style="display: none; "></span>
1539 </span>
1540 </span>
1541 )
1542 </div>
1543
1544 </em>
1545 </dt>
1546 <dd class="todo" style="display: none; ">
1547 Undocumented.
1548 </dd>
1549 <dd>A single key or a list of keys for items to remove.</dd>
1550 <dd style="display: none; ">
1551 This parameter was added in version
1552 <b><span></span></b>.
1553 You must omit this parameter in earlier versions,
1554 and you may omit it in any version. If you require this
1555 parameter, the manifest key
1556 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1557 can ensure that your extension won't be run in an earlier browser ve rsion.
1558 </dd>
1559
1560 <!-- OBJECT PROPERTIES -->
1561 <dd style="display: none; ">
1562 <dl>
1563 <div>
1564 <div>
1565 </div>
1566 </div>
1567 </dl>
1568 </dd>
1569
1570 <!-- OBJECT METHODS -->
1571 <dd style="display: none; ">
1572 <div></div>
1573 </dd>
1574
1575 <!-- OBJECT EVENT FIELDS -->
1576 <dd style="display: none; ">
1577 <div></div>
1578 </dd>
1579
1580 <!-- FUNCTION PARAMETERS -->
1581 <dd style="display: none; ">
1582 <div></div>
1583 </dd>
1584
1585 </div>
1586 </div><div>
1587 <div>
1588 <dt>
1589 <var>callback</var>
1590 <em>
1591
1592 <!-- TYPE -->
1593 <div style="display:inline">
1594 (
1595 <span class="optional">optional</span>
1596 <span class="enum" style="display: none; ">enumerated</span>
1597 <span id="typeTemplate">
1598 <span style="display: none; ">
1599 <a> Type</a>
1600 </span>
1601 <span>
1602 <span style="display: none; ">
1603 array of <span><span></span></span>
1604 </span>
1605 <span>function</span>
1606 <span style="display: none; "></span>
1607 </span>
1608 </span>
1609 )
1610 </div>
1611
1612 </em>
1613 </dt>
1614 <dd class="todo" style="display: none; ">
1615 Undocumented.
1616 </dd>
1617 <dd>Callback on success, or on failure (in which case lastError will b e set).</dd>
1618 <dd style="display: none; ">
1619 This parameter was added in version
1620 <b><span></span></b>.
1621 You must omit this parameter in earlier versions,
1622 and you may omit it in any version. If you require this
1623 parameter, the manifest key
1624 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1625 can ensure that your extension won't be run in an earlier browser ve rsion.
1626 </dd>
1627
1628 <!-- OBJECT PROPERTIES -->
1629 <dd style="display: none; ">
1630 <dl>
1631 <div>
1632 <div>
1633 </div>
1634 </div>
1635 </dl>
1636 </dd>
1637
1638 <!-- OBJECT METHODS -->
1639 <dd style="display: none; ">
1640 <div></div>
1641 </dd>
1642
1643 <!-- OBJECT EVENT FIELDS -->
1644 <dd style="display: none; ">
1645 <div></div>
1646 </dd>
1647
1648 <!-- FUNCTION PARAMETERS -->
1649 <dd style="display: none; ">
1650 <div></div>
1651 </dd>
1652
1653 </div>
1654 </div>
1655 </dl>
1656
1657 <!-- RETURNS -->
1658 <h4 style="display: none; ">Returns</h4>
1659 <dl>
1660 <div style="display: none; ">
1661 <div>
1662 </div>
1663 </div>
1664 </dl>
1665
1666 <!-- CALLBACK -->
1667 <div>
1668 <div>
1669 <h4>Callback function</h4>
1670 <p style="display: none; ">
1671 The callback <em>parameter</em> should specify a function
1672 that looks like this:
1673 </p>
1674 <p>
1675 If you specify the <em>callback</em> parameter, it should
1676 specify a function that looks like this:
1677 </p>
1678
1679 <!-- Note: intentionally longer 80 columns -->
1680 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1681 <dl>
1682 <div style="display: none; ">
1683 <div>
1684 </div>
1685 </div>
1686 </dl>
1687 </div>
1688 </div>
1689
1690 <!-- MIN_VERSION -->
1691 <p style="display: none; ">
1692 This function was added in version <b><span></span></b>.
1693 If you require this function, the manifest key
1694 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1695 can ensure that your extension won't be run in an earlier brow ser version.
1696 </p>
1697 </div> <!-- /description -->
1698
1699 </div><div class="apiItem">
1700 <a name="method-StorageNamespace-set"></a> <!-- method-anchor -->
1701 <h4>set</h4>
1702
1703 <div class="summary"><span style="display: none; ">void</span>
1704 <!-- Note: intentionally longer 80 columns -->
1705 <span>storageNamespace.set</span>(<span class="null"><span sty le="display: none; ">, </span><span>object</span>
1706 <var><span>items</span></var></span><span class="optional" ><span>, </span><span>function</span>
1707 <var><span>callback</span></var></span>)</div>
1708
1709 <div class="description">
1710 <p class="todo" style="display: none; ">Undocumented.</p>
1711 <p>Sets multiple items.</p>
1712
1713 <!-- PARAMETERS -->
1714 <h4>Parameters</h4>
1715 <dl>
1716 <div>
1717 <div>
1718 <dt>
1719 <var>items</var>
1720 <em>
1721
1722 <!-- TYPE -->
1723 <div style="display:inline">
1724 (
1725 <span class="optional" style="display: none; ">optional</spa n>
1726 <span class="enum" style="display: none; ">enumerated</span>
1727 <span id="typeTemplate">
1728 <span style="display: none; ">
1729 <a> Type</a>
1730 </span>
1731 <span>
1732 <span style="display: none; ">
1733 array of <span><span></span></span>
1734 </span>
1735 <span>object</span>
1736 <span style="display: none; "></span>
1737 </span>
1738 </span>
1739 )
1740 </div>
1741
1742 </em>
1743 </dt>
1744 <dd class="todo" style="display: none; ">
1745 Undocumented.
1746 </dd>
1747 <dd>Object specifying items to augment storage with. Values that canno t be serialized (functions, etc) will be ignored.</dd>
1748 <dd style="display: none; ">
1749 This parameter was added in version
1750 <b><span></span></b>.
1751 You must omit this parameter in earlier versions,
1752 and you may omit it in any version. If you require this
1753 parameter, the manifest key
1754 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1755 can ensure that your extension won't be run in an earlier browser ve rsion.
1756 </dd>
1757
1758 <!-- OBJECT PROPERTIES -->
1759 <dd>
1760 <dl>
1761 <div style="display: none; ">
1762 <div>
1763 </div>
1764 </div>
1765 </dl>
1766 </dd>
1767
1768 <!-- OBJECT METHODS -->
1769 <dd style="display: none; ">
1770 <div></div>
1771 </dd>
1772
1773 <!-- OBJECT EVENT FIELDS -->
1774 <dd style="display: none; ">
1775 <div></div>
1776 </dd>
1777
1778 <!-- FUNCTION PARAMETERS -->
1779 <dd style="display: none; ">
1780 <div></div>
1781 </dd>
1782
1783 </div>
1784 </div><div>
1785 <div>
1786 <dt>
1787 <var>callback</var>
1788 <em>
1789
1790 <!-- TYPE -->
1791 <div style="display:inline">
1792 (
1793 <span class="optional">optional</span>
1794 <span class="enum" style="display: none; ">enumerated</span>
1795 <span id="typeTemplate">
1796 <span style="display: none; ">
1797 <a> Type</a>
1798 </span>
1799 <span>
1800 <span style="display: none; ">
1801 array of <span><span></span></span>
1802 </span>
1803 <span>function</span>
1804 <span style="display: none; "></span>
1805 </span>
1806 </span>
1807 )
1808 </div>
1809
1810 </em>
1811 </dt>
1812 <dd class="todo" style="display: none; ">
1813 Undocumented.
1814 </dd>
1815 <dd>Callback on success, or on failure (in which case lastError will b e set).</dd>
1816 <dd style="display: none; ">
1817 This parameter was added in version
1818 <b><span></span></b>.
1819 You must omit this parameter in earlier versions,
1820 and you may omit it in any version. If you require this
1821 parameter, the manifest key
1822 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1823 can ensure that your extension won't be run in an earlier browser ve rsion.
1824 </dd>
1825
1826 <!-- OBJECT PROPERTIES -->
1827 <dd style="display: none; ">
1828 <dl>
1829 <div>
1830 <div>
1831 </div>
1832 </div>
1833 </dl>
1834 </dd>
1835
1836 <!-- OBJECT METHODS -->
1837 <dd style="display: none; ">
1838 <div></div>
1839 </dd>
1840
1841 <!-- OBJECT EVENT FIELDS -->
1842 <dd style="display: none; ">
1843 <div></div>
1844 </dd>
1845
1846 <!-- FUNCTION PARAMETERS -->
1847 <dd style="display: none; ">
1848 <div></div>
1849 </dd>
1850
1851 </div>
1852 </div>
1853 </dl>
1854
1855 <!-- RETURNS -->
1856 <h4 style="display: none; ">Returns</h4>
1857 <dl>
1858 <div style="display: none; ">
1859 <div>
1860 </div>
1861 </div>
1862 </dl>
1863
1864 <!-- CALLBACK -->
1865 <div>
1866 <div>
1867 <h4>Callback function</h4>
1868 <p style="display: none; ">
1869 The callback <em>parameter</em> should specify a function
1870 that looks like this:
1871 </p>
1872 <p>
1873 If you specify the <em>callback</em> parameter, it should
1874 specify a function that looks like this:
1875 </p>
1876
1877 <!-- Note: intentionally longer 80 columns -->
1878 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1879 <dl>
1880 <div style="display: none; ">
1881 <div>
1882 </div>
1883 </div>
1884 </dl>
1885 </div>
1886 </div>
1887
1888 <!-- MIN_VERSION -->
1889 <p style="display: none; ">
1890 This function was added in version <b><span></span></b>.
1891 If you require this function, the manifest key
1892 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1893 can ensure that your extension won't be run in an earlier brow ser version.
1894 </p>
1895 </div> <!-- /description -->
1896
1897 </div> <!-- /apiItem -->
1898
1899 </div>
1900 </dd>
1901
1902 <!-- OBJECT EVENT FIELDS -->
1903 <dd style="display: none; ">
1904 <div></div>
1905 </dd>
1906
1907 <!-- FUNCTION PARAMETERS -->
1908 <dd style="display: none; ">
1909 <div></div>
1910 </dd>
1911
1912 </div>
1913 510
1914 </div> <!-- /apiItem --> 511 </div> <!-- /apiItem -->
1915 512
1916 </div> <!-- /apiGroup --> 513 </div> <!-- /apiGroup -->
1917 514
1918 </div> <!-- /apiPage --> 515 </div> <!-- /apiPage -->
1919 </div> <!-- /gc-pagecontent --> 516 </div> <!-- /gc-pagecontent -->
1920 </div> <!-- /g-section --> 517 </div> <!-- /g-section -->
1921 </div> <!-- /codesiteContent --> 518 </div> <!-- /codesiteContent -->
1922 <div id="gc-footer" --=""> 519 <div id="gc-footer" --="">
(...skipping 26 matching lines...) Expand all
1949 _uff=0; 546 _uff=0;
1950 urchinTracker(); 547 urchinTracker();
1951 } 548 }
1952 catch(e) {/* urchinTracker not available. */} 549 catch(e) {/* urchinTracker not available. */}
1953 </script> 550 </script>
1954 <!-- end analytics --> 551 <!-- end analytics -->
1955 </div> 552 </div>
1956 </div> <!-- /gc-footer --> 553 </div> <!-- /gc-footer -->
1957 </div> <!-- /gc-container --> 554 </div> <!-- /gc-container -->
1958 </body></html> 555 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698