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

Issues Search
    My Issues | Starred     Open | Closed | All

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

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

Powered by Google App Engine
This is Rietveld 408576698