experimental.extension.html revision ddb351dbec246cf1fab5ec20d2d5520909041de1
1<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 2 1) The <head> information in this page is significant, should be uniform 3 across api docs and should be edited only with knowledge of the 4 templating mechanism. 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 6 browser, it will be re-generated from the template, json schema and 7 authored overview content. 8 4) The <body>.innerHTML is also generated by an offline step so that this 9 page may easily be indexed by search engines. 10--><html xmlns="http://www.w3.org/1999/xhtml"><head> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 14 <script type="text/javascript" src="/third_party/jstemplate/jstemplate_compiled.js"> 15 </script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script> 19 <title>chrome.experimental.extension - Google Chrome Extensions - Google Code</title></head> 20 <body> <div id="gc-container" class="labs"> 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. 23 </div> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 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 27 are not operated on by way of the jsskip="true" --> 28 <div style="display:none"> 29 30 <!-- VALUE --> 31 <div id="valueTemplate"> 32 <dt> 33 <var>paramName</var> 34 <em> 35 36 <!-- TYPE --> 37 <div style="display:inline"> 38 ( 39 <span class="optional">optional</span> 40 <span class="enum">enumerated</span> 41 <span id="typeTemplate"> 42 <span> 43 <a> Type</a> 44 </span> 45 <span> 46 <span> 47 array of <span><span></span></span> 48 </span> 49 <span>paramType</span> 50 <span></span> 51 </span> 52 </span> 53 ) 54 </div> 55 56 </em> 57 </dt> 58 <dd class="todo"> 59 Undocumented. 60 </dd> 61 <dd> 62 Description of this parameter from the json schema. 63 </dd> 64 <dd> 65 This parameter was added in version 66 <b><span></span></b>. 67 You must omit this parameter in earlier versions, 68 and you may omit it in any version. If you require this 69 parameter, the manifest key 70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 72 </dd> 73 74 <!-- OBJECT PROPERTIES --> 75 <dd> 76 <dl> 77 <div> 78 <div> 79 </div> 80 </div> 81 </dl> 82 </dd> 83 84 <!-- OBJECT METHODS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 <!-- OBJECT EVENT FIELDS --> 90 <dd> 91 <div></div> 92 </dd> 93 94 <!-- FUNCTION PARAMETERS --> 95 <dd> 96 <div></div> 97 </dd> 98 99 </div> <!-- /VALUE --> 100 101 <div id="functionParametersTemplate"> 102 <h5>Parameters</h5> 103 <dl> 104 <div> 105 <div> 106 </div> 107 </div> 108 </dl> 109 </div> 110 </div> <!-- /SUBTEMPLATES --> 111 112 <a id="top"></a> 113 <div id="skipto"> 114 <a href="#gc-pagecontent">Skip to page content</a> 115 <a href="#gc-toc">Skip to main navigation</a> 116 </div> 117 <!-- API HEADER --> 118 <table id="header" width="100%" cellspacing="0" border="0"> 119 <tbody><tr> 120 <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td> 121 <td valign="middle" width="100%" style="padding-left:0.6em;"> 122 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 123 <div id="gsc-search-box"> 124 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 125 <input type="hidden" name="ie" value="UTF-8"> 126 <input type="text" name="q" value="" size="55"> 127 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 128 <br> 129 <span class="greytext">e.g. "page action" or "tabs"</span> 130 </div> 131 </form> 132 133 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 136 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 137 </td> 138 </tr> 139 </tbody></table> 140 141 <div id="codesiteContent" class=""> 142 143 <a id="gc-topnav-anchor"></a> 144 <div id="gc-topnav"> 145 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 146 <ul id="home" class="gc-topnav-tabs"> 147 <li id="home_link"> 148 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 149 </li> 150 <li id="docs_link"> 151 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 152 </li> 153 <li id="faq_link"> 154 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 155 </li> 156 <li id="samples_link"> 157 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 158 </li> 159 <li id="group_link"> 160 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 161 </li> 162 </ul> 163 </div> <!-- end gc-topnav --> 164 165 <div class="g-section g-tpl-170"> 166 <!-- SIDENAV --> 167 <div class="g-unit g-first" id="gc-toc"> 168 <ul> 169 <li><a href="getstarted.html">Getting Started</a></li> 170 <li><a href="overview.html">Overview</a></li> 171 <li><a href="whats_new.html">What's New?</a></li> 172 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 173 <ul> 174 <li>Browser UI 175 <ul> 176 <li><a href="browserAction.html">Browser Actions</a></li> 177 <li><a href="contextMenus.html">Context Menus</a></li> 178 <li><a href="notifications.html">Desktop Notifications</a></li> 179 <li><a href="omnibox.html">Omnibox</a></li> 180 <li><a href="options.html">Options Pages</a></li> 181 <li><a href="override.html">Override Pages</a></li> 182 <li><a href="pageAction.html">Page Actions</a></li> 183 </ul> 184 </li> 185 <li>Browser Interaction 186 <ul> 187 <li><a href="bookmarks.html">Bookmarks</a></li> 188 <li><a href="cookies.html">Cookies</a></li> 189 <li><a href="events.html">Events</a></li> 190 <li><a href="history.html">History</a></li> 191 <li><a href="management.html">Management</a></li> 192 <li><a href="tabs.html">Tabs</a></li> 193 <li><a href="windows.html">Windows</a></li> 194 </ul> 195 </li> 196 <li>Implementation 197 <ul> 198 <li><a href="a11y.html">Accessibility</a></li> 199 <li><a href="background_pages.html">Background Pages</a></li> 200 <li><a href="content_scripts.html">Content Scripts</a></li> 201 <li><a href="xhr.html">Cross-Origin XHR</a></li> 202 <li><a href="idle.html">Idle</a></li> 203 <li><a href="i18n.html">Internationalization</a></li> 204 <li><a href="messaging.html">Message Passing</a></li> 205 <li><a href="npapi.html">NPAPI Plugins</a></li> 206 </ul> 207 </li> 208 <li>Finishing 209 <ul> 210 <li><a href="hosting.html">Hosting</a></li> 211 <li><a href="external_extensions.html">Other Deployment Options</a></li> 212 </ul> 213 </li> 214 </ul> 215 </li> 216 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 217 <li><h2><a href="tutorials.html">Tutorials</a></h2> 218 <ul> 219 <li><a href="tut_debugging.html">Debugging</a></li> 220 <li><a href="tut_analytics.html">Google Analytics</a></li> 221 <li><a href="tut_oauth.html">OAuth</a></li> 222 </ul> 223 </li> 224 <li><h2>Reference</h2> 225 <ul> 226 <li>Formats 227 <ul> 228 <li><a href="manifest.html">Manifest Files</a></li> 229 <li><a href="match_patterns.html">Match Patterns</a></li> 230 </ul> 231 </li> 232 <li><a href="permission_warnings.html">Permission Warnings</a></li> 233 <li><a href="api_index.html">chrome.* APIs</a></li> 234 <li><a href="api_other.html">Other APIs</a></li> 235 </ul> 236 </li> 237 <li><h2><a href="samples.html">Samples</a></h2></li> 238 <div class="line"> </div> 239 <li><h2>More</h2> 240 <ul> 241 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 242 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 243 <li><a href="themes.html">Themes</a></li> 244 </ul> 245 </li> 246 </ul> 247 </div> 248 <script> 249 initToggles(); 250 </script> 251 252 <div class="g-unit" id="gc-pagecontent"> 253 <div id="pageTitle"> 254 <h1 class="page_title">chrome.experimental.extension</h1> 255 </div> 256 <!-- TABLE OF CONTENTS --> 257 <div id="toc"> 258 <h2>Contents</h2> 259 <ol> 260 <li style="display: none; "> 261 <a>h2Name</a> 262 <ol> 263 <li> 264 <a>h3Name</a> 265 </li> 266 </ol> 267 </li> 268 <li> 269 <a href="#apiReference">API reference: chrome.experimental.extension</a> 270 <ol> 271 <li style="display: none; "> 272 <a href="#properties">Properties</a> 273 <ol> 274 <li> 275 <a href="#property-anchor">propertyName</a> 276 </li> 277 </ol> 278 </li> 279 <li style="display: none; "> 280 <a>Methods</a> 281 <ol> 282 <li> 283 <a href="#method-anchor">methodName</a> 284 </li> 285 </ol> 286 </li> 287 <li style="display: none; "> 288 <a>Events</a> 289 <ol> 290 <li> 291 <a href="#event-anchor">eventName</a> 292 </li> 293 </ol> 294 </li> 295 <li> 296 <a href="#types">Types</a> 297 <ol> 298 <li> 299 <a href="#type-Preference">Preference</a> 300 </li> 301 </ol> 302 </li> 303 </ol> 304 </li> 305 </ol> 306 </div> 307 <!-- /TABLE OF CONTENTS --> 308 309 <!-- Standard content lead-in for experimental API pages --> 310 <p id="classSummary"> 311 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 312 </p> 313 314 <!-- STATIC CONTENT PLACEHOLDER --> 315 <div id="static"></div> 316 317 <!-- API PAGE --> 318 <div class="apiPage"> 319 <a name="apiReference"></a> 320 <h2>API reference: chrome.experimental.extension</h2> 321 322 <!-- PROPERTIES --> 323 <div class="apiGroup" style="display: none; "> 324 <a name="properties"></a> 325 <h3 id="properties">Properties</h3> 326 327 <div> 328 <a></a> 329 <h4>getLastError</h4> 330 <div class="summary"> 331 <!-- Note: intentionally longer 80 columns --> 332 <span>chrome.extension</span><span>lastError</span> 333 </div> 334 <div> 335 </div> 336 </div> 337 338 </div> <!-- /apiGroup --> 339 340 <!-- METHODS --> 341 <div id="methodsTemplate" class="apiGroup" style="display: none; "> 342 <a></a> 343 <h3>Methods</h3> 344 345 <!-- iterates over all functions --> 346 <div class="apiItem"> 347 <a></a> <!-- method-anchor --> 348 <h4>method name</h4> 349 350 <div class="summary"><span>void</span> 351 <!-- Note: intentionally longer 80 columns --> 352 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 353 <var><span></span></var></span>)</div> 354 355 <div class="description"> 356 <p class="todo">Undocumented.</p> 357 <p> 358 A description from the json schema def of the function goes here. 359 </p> 360 361 <!-- PARAMETERS --> 362 <h4>Parameters</h4> 363 <dl> 364 <div> 365 <div> 366 </div> 367 </div> 368 </dl> 369 370 <!-- RETURNS --> 371 <h4>Returns</h4> 372 <dl> 373 <div> 374 <div> 375 </div> 376 </div> 377 </dl> 378 379 <!-- CALLBACK --> 380 <div> 381 <div> 382 <h4>Callback function</h4> 383 <p> 384 The callback <em>parameter</em> should specify a function 385 that looks like this: 386 </p> 387 <p> 388 If you specify the <em>callback</em> parameter, it should 389 specify a function that looks like this: 390 </p> 391 392 <!-- Note: intentionally longer 80 columns --> 393 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 394 <dl> 395 <div> 396 <div> 397 </div> 398 </div> 399 </dl> 400 </div> 401 </div> 402 403 <!-- MIN_VERSION --> 404 <p> 405 This function was added in version <b><span></span></b>. 406 If you require this function, the manifest key 407 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 408 can ensure that your extension won't be run in an earlier browser version. 409 </p> 410 </div> <!-- /description --> 411 412 </div> <!-- /apiItem --> 413 414 </div> <!-- /apiGroup --> 415 416 <!-- EVENTS --> 417 <div id="eventsTemplate" class="apiGroup" style="display: none; "> 418 <a></a> 419 <h3>Events</h3> 420 <!-- iterates over all events --> 421 <div class="apiItem"> 422 <a></a> 423 <h4>event name</h4> 424 425 <div class="summary"> 426 <!-- Note: intentionally longer 80 columns --> 427 <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>); 428 </div> 429 430 <div class="description"> 431 <p class="todo">Undocumented.</p> 432 <p> 433 A description from the json schema def of the event goes here. 434 </p> 435 436 <!-- PARAMETERS --> 437 <div> 438 <h4>Parameters</h4> 439 <dl> 440 <div> 441 <div> 442 </div> 443 </div> 444 </dl> 445 </div> 446 </div> <!-- /decription --> 447 448 </div> <!-- /apiItem --> 449 450 </div> <!-- /apiGroup --> 451 452 <!-- TYPES --> 453 <div class="apiGroup"> 454 <a name="types"></a> 455 <h3 id="types">Types</h3> 456 457 <!-- iterates over all types --> 458 <div class="apiItem"> 459 <a name="type-Preference"></a> 460 <h4>Preference</h4> 461 462 <div> 463 <dt> 464 <var style="display: none; ">paramName</var> 465 <em> 466 467 <!-- TYPE --> 468 <div style="display:inline"> 469 ( 470 <span class="optional" style="display: none; ">optional</span> 471 <span class="enum" style="display: none; ">enumerated</span> 472 <span id="typeTemplate"> 473 <span style="display: none; "> 474 <a> Type</a> 475 </span> 476 <span> 477 <span style="display: none; "> 478 array of <span><span></span></span> 479 </span> 480 <span>object</span> 481 <span style="display: none; "></span> 482 </span> 483 </span> 484 ) 485 </div> 486 487 </em> 488 </dt> 489 <dd class="todo" style="display: none; "> 490 Undocumented. 491 </dd> 492 <dd>An object which allows access to a preference.</dd> 493 <dd style="display: none; "> 494 This parameter was added in version 495 <b><span></span></b>. 496 You must omit this parameter in earlier versions, 497 and you may omit it in any version. If you require this 498 parameter, the manifest key 499 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 500 can ensure that your extension won't be run in an earlier browser version. 501 </dd> 502 503 <!-- OBJECT PROPERTIES --> 504 <dd style="display: none; "> 505 <dl> 506 <div> 507 <div> 508 </div> 509 </div> 510 </dl> 511 </dd> 512 513 <!-- OBJECT METHODS --> 514 <dd> 515 <div class="apiGroup" style=""> 516 <a name="global-Preference-methods"></a> 517 <h3>Methods of Preference</h3> 518 519 <!-- iterates over all functions --> 520 <div class="apiItem"> 521 <a name="method-Preference-clear"></a> <!-- method-anchor --> 522 <h4>clear</h4> 523 524 <div class="summary"><span style="display: none; ">void</span> 525 <!-- Note: intentionally longer 80 columns --> 526 <span>preference.clear</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 527 <var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span> 528 <var><span>callback</span></var></span>)</div> 529 530 <div class="description"> 531 <p class="todo" style="display: none; ">Undocumented.</p> 532 <p>Clears the setting in the user preferences. This way default settings can become effective again.</p> 533 534 <!-- PARAMETERS --> 535 <h4>Parameters</h4> 536 <dl> 537 <div> 538 <div> 539 <dt> 540 <var>details</var> 541 <em> 542 543 <!-- TYPE --> 544 <div style="display:inline"> 545 ( 546 <span class="optional" style="display: none; ">optional</span> 547 <span class="enum" style="display: none; ">enumerated</span> 548 <span id="typeTemplate"> 549 <span style="display: none; "> 550 <a> Type</a> 551 </span> 552 <span> 553 <span style="display: none; "> 554 array of <span><span></span></span> 555 </span> 556 <span>object</span> 557 <span style="display: none; "></span> 558 </span> 559 </span> 560 ) 561 </div> 562 563 </em> 564 </dt> 565 <dd class="todo" style="display: none; "> 566 Undocumented. 567 </dd> 568 <dd>What setting to clear.</dd> 569 <dd style="display: none; "> 570 This parameter was added in version 571 <b><span></span></b>. 572 You must omit this parameter in earlier versions, 573 and you may omit it in any version. If you require this 574 parameter, the manifest key 575 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 576 can ensure that your extension won't be run in an earlier browser version. 577 </dd> 578 579 <!-- OBJECT PROPERTIES --> 580 <dd> 581 <dl> 582 <div> 583 <div> 584 <dt> 585 <var>incognito</var> 586 <em> 587 588 <!-- TYPE --> 589 <div style="display:inline"> 590 ( 591 <span class="optional">optional</span> 592 <span class="enum" style="display: none; ">enumerated</span> 593 <span id="typeTemplate"> 594 <span style="display: none; "> 595 <a> Type</a> 596 </span> 597 <span> 598 <span style="display: none; "> 599 array of <span><span></span></span> 600 </span> 601 <span>boolean</span> 602 <span style="display: none; "></span> 603 </span> 604 </span> 605 ) 606 </div> 607 608 </em> 609 </dt> 610 <dd class="todo" style="display: none; "> 611 Undocumented. 612 </dd> 613 <dd>Whether to clear the setting for the incognito session only (default false).</dd> 614 <dd style="display: none; "> 615 This parameter was added in version 616 <b><span></span></b>. 617 You must omit this parameter in earlier versions, 618 and you may omit it in any version. If you require this 619 parameter, the manifest key 620 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 621 can ensure that your extension won't be run in an earlier browser version. 622 </dd> 623 624 <!-- OBJECT PROPERTIES --> 625 <dd style="display: none; "> 626 <dl> 627 <div> 628 <div> 629 </div> 630 </div> 631 </dl> 632 </dd> 633 634 <!-- OBJECT METHODS --> 635 <dd style="display: none; "> 636 <div></div> 637 </dd> 638 639 <!-- OBJECT EVENT FIELDS --> 640 <dd style="display: none; "> 641 <div></div> 642 </dd> 643 644 <!-- FUNCTION PARAMETERS --> 645 <dd style="display: none; "> 646 <div></div> 647 </dd> 648 649 </div> 650 </div> 651 </dl> 652 </dd> 653 654 <!-- OBJECT METHODS --> 655 <dd style="display: none; "> 656 <div></div> 657 </dd> 658 659 <!-- OBJECT EVENT FIELDS --> 660 <dd style="display: none; "> 661 <div></div> 662 </dd> 663 664 <!-- FUNCTION PARAMETERS --> 665 <dd style="display: none; "> 666 <div></div> 667 </dd> 668 669 </div> 670 </div><div> 671 <div> 672 <dt> 673 <var>callback</var> 674 <em> 675 676 <!-- TYPE --> 677 <div style="display:inline"> 678 ( 679 <span class="optional">optional</span> 680 <span class="enum" style="display: none; ">enumerated</span> 681 <span id="typeTemplate"> 682 <span style="display: none; "> 683 <a> Type</a> 684 </span> 685 <span> 686 <span style="display: none; "> 687 array of <span><span></span></span> 688 </span> 689 <span>function</span> 690 <span style="display: none; "></span> 691 </span> 692 </span> 693 ) 694 </div> 695 696 </em> 697 </dt> 698 <dd class="todo" style="display: none; "> 699 Undocumented. 700 </dd> 701 <dd>Called after the preference has been cleared.</dd> 702 <dd style="display: none; "> 703 This parameter was added in version 704 <b><span></span></b>. 705 You must omit this parameter in earlier versions, 706 and you may omit it in any version. If you require this 707 parameter, the manifest key 708 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 709 can ensure that your extension won't be run in an earlier browser version. 710 </dd> 711 712 <!-- OBJECT PROPERTIES --> 713 <dd style="display: none; "> 714 <dl> 715 <div> 716 <div> 717 </div> 718 </div> 719 </dl> 720 </dd> 721 722 <!-- OBJECT METHODS --> 723 <dd style="display: none; "> 724 <div></div> 725 </dd> 726 727 <!-- OBJECT EVENT FIELDS --> 728 <dd style="display: none; "> 729 <div></div> 730 </dd> 731 732 <!-- FUNCTION PARAMETERS --> 733 <dd style="display: none; "> 734 <div></div> 735 </dd> 736 737 </div> 738 </div> 739 </dl> 740 741 <!-- RETURNS --> 742 <h4 style="display: none; ">Returns</h4> 743 <dl> 744 <div style="display: none; "> 745 <div> 746 </div> 747 </div> 748 </dl> 749 750 <!-- CALLBACK --> 751 <div> 752 <div> 753 <h4>Callback function</h4> 754 <p style="display: none; "> 755 The callback <em>parameter</em> should specify a function 756 that looks like this: 757 </p> 758 <p> 759 If you specify the <em>callback</em> parameter, it should 760 specify a function that looks like this: 761 </p> 762 763 <!-- Note: intentionally longer 80 columns --> 764 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 765 <dl> 766 <div style="display: none; "> 767 <div> 768 </div> 769 </div> 770 </dl> 771 </div> 772 </div> 773 774 <!-- MIN_VERSION --> 775 <p style="display: none; "> 776 This function was added in version <b><span></span></b>. 777 If you require this function, the manifest key 778 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 779 can ensure that your extension won't be run in an earlier browser version. 780 </p> 781 </div> <!-- /description --> 782 783 </div><div class="apiItem"> 784 <a name="method-Preference-get"></a> <!-- method-anchor --> 785 <h4>get</h4> 786 787 <div class="summary"><span style="display: none; ">void</span> 788 <!-- Note: intentionally longer 80 columns --> 789 <span>preference.get</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 790 <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span> 791 <var><span>callback</span></var></span>)</div> 792 793 <div class="description"> 794 <p class="todo" style="display: none; ">Undocumented.</p> 795 <p>Get the setting from the user preferences.</p> 796 797 <!-- PARAMETERS --> 798 <h4>Parameters</h4> 799 <dl> 800 <div> 801 <div> 802 <dt> 803 <var>details</var> 804 <em> 805 806 <!-- TYPE --> 807 <div style="display:inline"> 808 ( 809 <span class="optional" style="display: none; ">optional</span> 810 <span class="enum" style="display: none; ">enumerated</span> 811 <span id="typeTemplate"> 812 <span style="display: none; "> 813 <a> Type</a> 814 </span> 815 <span> 816 <span style="display: none; "> 817 array of <span><span></span></span> 818 </span> 819 <span>object</span> 820 <span style="display: none; "></span> 821 </span> 822 </span> 823 ) 824 </div> 825 826 </em> 827 </dt> 828 <dd class="todo" style="display: none; "> 829 Undocumented. 830 </dd> 831 <dd>What setting to return.</dd> 832 <dd style="display: none; "> 833 This parameter was added in version 834 <b><span></span></b>. 835 You must omit this parameter in earlier versions, 836 and you may omit it in any version. If you require this 837 parameter, the manifest key 838 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 839 can ensure that your extension won't be run in an earlier browser version. 840 </dd> 841 842 <!-- OBJECT PROPERTIES --> 843 <dd> 844 <dl> 845 <div> 846 <div> 847 <dt> 848 <var>incognito</var> 849 <em> 850 851 <!-- TYPE --> 852 <div style="display:inline"> 853 ( 854 <span class="optional">optional</span> 855 <span class="enum" style="display: none; ">enumerated</span> 856 <span id="typeTemplate"> 857 <span style="display: none; "> 858 <a> Type</a> 859 </span> 860 <span> 861 <span style="display: none; "> 862 array of <span><span></span></span> 863 </span> 864 <span>boolean</span> 865 <span style="display: none; "></span> 866 </span> 867 </span> 868 ) 869 </div> 870 871 </em> 872 </dt> 873 <dd class="todo" style="display: none; "> 874 Undocumented. 875 </dd> 876 <dd>Whether to return the setting that applies to the incognito session (default false).</dd> 877 <dd style="display: none; "> 878 This parameter was added in version 879 <b><span></span></b>. 880 You must omit this parameter in earlier versions, 881 and you may omit it in any version. If you require this 882 parameter, the manifest key 883 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 884 can ensure that your extension won't be run in an earlier browser version. 885 </dd> 886 887 <!-- OBJECT PROPERTIES --> 888 <dd style="display: none; "> 889 <dl> 890 <div> 891 <div> 892 </div> 893 </div> 894 </dl> 895 </dd> 896 897 <!-- OBJECT METHODS --> 898 <dd style="display: none; "> 899 <div></div> 900 </dd> 901 902 <!-- OBJECT EVENT FIELDS --> 903 <dd style="display: none; "> 904 <div></div> 905 </dd> 906 907 <!-- FUNCTION PARAMETERS --> 908 <dd style="display: none; "> 909 <div></div> 910 </dd> 911 912 </div> 913 </div> 914 </dl> 915 </dd> 916 917 <!-- OBJECT METHODS --> 918 <dd style="display: none; "> 919 <div></div> 920 </dd> 921 922 <!-- OBJECT EVENT FIELDS --> 923 <dd style="display: none; "> 924 <div></div> 925 </dd> 926 927 <!-- FUNCTION PARAMETERS --> 928 <dd style="display: none; "> 929 <div></div> 930 </dd> 931 932 </div> 933 </div><div> 934 <div> 935 <dt> 936 <var>callback</var> 937 <em> 938 939 <!-- TYPE --> 940 <div style="display:inline"> 941 ( 942 <span class="optional" style="display: none; ">optional</span> 943 <span class="enum" style="display: none; ">enumerated</span> 944 <span id="typeTemplate"> 945 <span style="display: none; "> 946 <a> Type</a> 947 </span> 948 <span> 949 <span style="display: none; "> 950 array of <span><span></span></span> 951 </span> 952 <span>function</span> 953 <span style="display: none; "></span> 954 </span> 955 </span> 956 ) 957 </div> 958 959 </em> 960 </dt> 961 <dd class="todo"> 962 Undocumented. 963 </dd> 964 <dd style="display: none; "> 965 Description of this parameter from the json schema. 966 </dd> 967 <dd style="display: none; "> 968 This parameter was added in version 969 <b><span></span></b>. 970 You must omit this parameter in earlier versions, 971 and you may omit it in any version. If you require this 972 parameter, the manifest key 973 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 974 can ensure that your extension won't be run in an earlier browser version. 975 </dd> 976 977 <!-- OBJECT PROPERTIES --> 978 <dd style="display: none; "> 979 <dl> 980 <div> 981 <div> 982 </div> 983 </div> 984 </dl> 985 </dd> 986 987 <!-- OBJECT METHODS --> 988 <dd style="display: none; "> 989 <div></div> 990 </dd> 991 992 <!-- OBJECT EVENT FIELDS --> 993 <dd style="display: none; "> 994 <div></div> 995 </dd> 996 997 <!-- FUNCTION PARAMETERS --> 998 <dd style="display: none; "> 999 <div></div> 1000 </dd> 1001 1002 </div> 1003 </div> 1004 </dl> 1005 1006 <!-- RETURNS --> 1007 <h4 style="display: none; ">Returns</h4> 1008 <dl> 1009 <div style="display: none; "> 1010 <div> 1011 </div> 1012 </div> 1013 </dl> 1014 1015 <!-- CALLBACK --> 1016 <div> 1017 <div> 1018 <h4>Callback function</h4> 1019 <p> 1020 The callback <em>parameter</em> should specify a function 1021 that looks like this: 1022 </p> 1023 <p style="display: none; "> 1024 If you specify the <em>callback</em> parameter, it should 1025 specify a function that looks like this: 1026 </p> 1027 1028 <!-- Note: intentionally longer 80 columns --> 1029 <pre>function(<span>object details</span>) <span class="subdued">{...}</span>;</pre> 1030 <dl> 1031 <div> 1032 <div> 1033 <dt> 1034 <var>details</var> 1035 <em> 1036 1037 <!-- TYPE --> 1038 <div style="display:inline"> 1039 ( 1040 <span class="optional" style="display: none; ">optional</span> 1041 <span class="enum" style="display: none; ">enumerated</span> 1042 <span id="typeTemplate"> 1043 <span style="display: none; "> 1044 <a> Type</a> 1045 </span> 1046 <span> 1047 <span style="display: none; "> 1048 array of <span><span></span></span> 1049 </span> 1050 <span>object</span> 1051 <span style="display: none; "></span> 1052 </span> 1053 </span> 1054 ) 1055 </div> 1056 1057 </em> 1058 </dt> 1059 <dd class="todo" style="display: none; "> 1060 Undocumented. 1061 </dd> 1062 <dd>Details of the currently effective preference value.</dd> 1063 <dd style="display: none; "> 1064 This parameter was added in version 1065 <b><span></span></b>. 1066 You must omit this parameter in earlier versions, 1067 and you may omit it in any version. If you require this 1068 parameter, the manifest key 1069 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1070 can ensure that your extension won't be run in an earlier browser version. 1071 </dd> 1072 1073 <!-- OBJECT PROPERTIES --> 1074 <dd> 1075 <dl> 1076 <div> 1077 <div> 1078 <dt> 1079 <var>value</var> 1080 <em> 1081 1082 <!-- TYPE --> 1083 <div style="display:inline"> 1084 ( 1085 <span class="optional" style="display: none; ">optional</span> 1086 <span class="enum" style="display: none; ">enumerated</span> 1087 <span id="typeTemplate"> 1088 <span style="display: none; "> 1089 <a> Type</a> 1090 </span> 1091 <span> 1092 <span style="display: none; "> 1093 array of <span><span></span></span> 1094 </span> 1095 <span>any</span> 1096 <span style="display: none; "></span> 1097 </span> 1098 </span> 1099 ) 1100 </div> 1101 1102 </em> 1103 </dt> 1104 <dd class="todo" style="display: none; "> 1105 Undocumented. 1106 </dd> 1107 <dd>The value of the preference.</dd> 1108 <dd style="display: none; "> 1109 This parameter was added in version 1110 <b><span></span></b>. 1111 You must omit this parameter in earlier versions, 1112 and you may omit it in any version. If you require this 1113 parameter, the manifest key 1114 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1115 can ensure that your extension won't be run in an earlier browser version. 1116 </dd> 1117 1118 <!-- OBJECT PROPERTIES --> 1119 <dd style="display: none; "> 1120 <dl> 1121 <div> 1122 <div> 1123 </div> 1124 </div> 1125 </dl> 1126 </dd> 1127 1128 <!-- OBJECT METHODS --> 1129 <dd style="display: none; "> 1130 <div></div> 1131 </dd> 1132 1133 <!-- OBJECT EVENT FIELDS --> 1134 <dd style="display: none; "> 1135 <div></div> 1136 </dd> 1137 1138 <!-- FUNCTION PARAMETERS --> 1139 <dd style="display: none; "> 1140 <div></div> 1141 </dd> 1142 1143 </div> 1144 </div><div> 1145 <div> 1146 <dt> 1147 <var>levelOfControl</var> 1148 <em> 1149 1150 <!-- TYPE --> 1151 <div style="display:inline"> 1152 ( 1153 <span class="optional" style="display: none; ">optional</span> 1154 <span class="enum">enumerated</span> 1155 <span id="typeTemplate"> 1156 <span style="display: none; "> 1157 <a> Type</a> 1158 </span> 1159 <span> 1160 <span style="display: none; "> 1161 array of <span><span></span></span> 1162 </span> 1163 <span>string</span> 1164 <span>["NotControllable", "ControlledByOtherExtensions", "ControllableByThisExtension", "ControlledByThisExtension"]</span> 1165 </span> 1166 </span> 1167 ) 1168 </div> 1169 1170 </em> 1171 </dt> 1172 <dd class="todo" style="display: none; "> 1173 Undocumented. 1174 </dd> 1175 <dd>One of<br><var>NotControllable</var>: cannot be controlled by any extension<br><var>ControlledByOtherExtensions</var>: controlled by extensions with higher precedence<br><var>ControllableByThisExtension</var>: can be controlled by this extension<br><var>ControlledByThisExtension</var>: controlled by this extension</dd> 1176 <dd style="display: none; "> 1177 This parameter was added in version 1178 <b><span></span></b>. 1179 You must omit this parameter in earlier versions, 1180 and you may omit it in any version. If you require this 1181 parameter, the manifest key 1182 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1183 can ensure that your extension won't be run in an earlier browser version. 1184 </dd> 1185 1186 <!-- OBJECT PROPERTIES --> 1187 <dd style="display: none; "> 1188 <dl> 1189 <div> 1190 <div> 1191 </div> 1192 </div> 1193 </dl> 1194 </dd> 1195 1196 <!-- OBJECT METHODS --> 1197 <dd style="display: none; "> 1198 <div></div> 1199 </dd> 1200 1201 <!-- OBJECT EVENT FIELDS --> 1202 <dd style="display: none; "> 1203 <div></div> 1204 </dd> 1205 1206 <!-- FUNCTION PARAMETERS --> 1207 <dd style="display: none; "> 1208 <div></div> 1209 </dd> 1210 1211 </div> 1212 </div><div> 1213 <div> 1214 <dt> 1215 <var>incognitoSpecific</var> 1216 <em> 1217 1218 <!-- TYPE --> 1219 <div style="display:inline"> 1220 ( 1221 <span class="optional">optional</span> 1222 <span class="enum" style="display: none; ">enumerated</span> 1223 <span id="typeTemplate"> 1224 <span style="display: none; "> 1225 <a> Type</a> 1226 </span> 1227 <span> 1228 <span style="display: none; "> 1229 array of <span><span></span></span> 1230 </span> 1231 <span>boolean</span> 1232 <span style="display: none; "></span> 1233 </span> 1234 </span> 1235 ) 1236 </div> 1237 1238 </em> 1239 </dt> 1240 <dd class="todo" style="display: none; "> 1241 Undocumented. 1242 </dd> 1243 <dd>Whether the effective value is specific to the incognito session.<br>This property will <em>only</em> be present if the <var>incognito</var> property in the <var>details</var> parameter of <code>get()</code> was true.</dd> 1244 <dd style="display: none; "> 1245 This parameter was added in version 1246 <b><span></span></b>. 1247 You must omit this parameter in earlier versions, 1248 and you may omit it in any version. If you require this 1249 parameter, the manifest key 1250 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1251 can ensure that your extension won't be run in an earlier browser version. 1252 </dd> 1253 1254 <!-- OBJECT PROPERTIES --> 1255 <dd style="display: none; "> 1256 <dl> 1257 <div> 1258 <div> 1259 </div> 1260 </div> 1261 </dl> 1262 </dd> 1263 1264 <!-- OBJECT METHODS --> 1265 <dd style="display: none; "> 1266 <div></div> 1267 </dd> 1268 1269 <!-- OBJECT EVENT FIELDS --> 1270 <dd style="display: none; "> 1271 <div></div> 1272 </dd> 1273 1274 <!-- FUNCTION PARAMETERS --> 1275 <dd style="display: none; "> 1276 <div></div> 1277 </dd> 1278 1279 </div> 1280 </div> 1281 </dl> 1282 </dd> 1283 1284 <!-- OBJECT METHODS --> 1285 <dd style="display: none; "> 1286 <div></div> 1287 </dd> 1288 1289 <!-- OBJECT EVENT FIELDS --> 1290 <dd style="display: none; "> 1291 <div></div> 1292 </dd> 1293 1294 <!-- FUNCTION PARAMETERS --> 1295 <dd style="display: none; "> 1296 <div></div> 1297 </dd> 1298 1299 </div> 1300 </div> 1301 </dl> 1302 </div> 1303 </div> 1304 1305 <!-- MIN_VERSION --> 1306 <p style="display: none; "> 1307 This function was added in version <b><span></span></b>. 1308 If you require this function, the manifest key 1309 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1310 can ensure that your extension won't be run in an earlier browser version. 1311 </p> 1312 </div> <!-- /description --> 1313 1314 </div><div class="apiItem"> 1315 <a name="method-Preference-set"></a> <!-- method-anchor --> 1316 <h4>set</h4> 1317 1318 <div class="summary"><span style="display: none; ">void</span> 1319 <!-- Note: intentionally longer 80 columns --> 1320 <span>preference.set</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1321 <var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span> 1322 <var><span>callback</span></var></span>)</div> 1323 1324 <div class="description"> 1325 <p class="todo" style="display: none; ">Undocumented.</p> 1326 <p>Set the setting in the user preferences</p> 1327 1328 <!-- PARAMETERS --> 1329 <h4>Parameters</h4> 1330 <dl> 1331 <div> 1332 <div> 1333 <dt> 1334 <var>details</var> 1335 <em> 1336 1337 <!-- TYPE --> 1338 <div style="display:inline"> 1339 ( 1340 <span class="optional" style="display: none; ">optional</span> 1341 <span class="enum" style="display: none; ">enumerated</span> 1342 <span id="typeTemplate"> 1343 <span style="display: none; "> 1344 <a> Type</a> 1345 </span> 1346 <span> 1347 <span style="display: none; "> 1348 array of <span><span></span></span> 1349 </span> 1350 <span>object</span> 1351 <span style="display: none; "></span> 1352 </span> 1353 </span> 1354 ) 1355 </div> 1356 1357 </em> 1358 </dt> 1359 <dd class="todo" style="display: none; "> 1360 Undocumented. 1361 </dd> 1362 <dd>What setting to change.</dd> 1363 <dd style="display: none; "> 1364 This parameter was added in version 1365 <b><span></span></b>. 1366 You must omit this parameter in earlier versions, 1367 and you may omit it in any version. If you require this 1368 parameter, the manifest key 1369 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1370 can ensure that your extension won't be run in an earlier browser version. 1371 </dd> 1372 1373 <!-- OBJECT PROPERTIES --> 1374 <dd> 1375 <dl> 1376 <div> 1377 <div> 1378 <dt> 1379 <var>value</var> 1380 <em> 1381 1382 <!-- TYPE --> 1383 <div style="display:inline"> 1384 ( 1385 <span class="optional" style="display: none; ">optional</span> 1386 <span class="enum" style="display: none; ">enumerated</span> 1387 <span id="typeTemplate"> 1388 <span style="display: none; "> 1389 <a> Type</a> 1390 </span> 1391 <span> 1392 <span style="display: none; "> 1393 array of <span><span></span></span> 1394 </span> 1395 <span>any</span> 1396 <span style="display: none; "></span> 1397 </span> 1398 </span> 1399 ) 1400 </div> 1401 1402 </em> 1403 </dt> 1404 <dd class="todo" style="display: none; "> 1405 Undocumented. 1406 </dd> 1407 <dd>The value of the preference. <br>Note that every preference has a specific value type, which is described together with the preference. An extension should <em>not</em> set a preference value of a different type.</dd> 1408 <dd style="display: none; "> 1409 This parameter was added in version 1410 <b><span></span></b>. 1411 You must omit this parameter in earlier versions, 1412 and you may omit it in any version. If you require this 1413 parameter, the manifest key 1414 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1415 can ensure that your extension won't be run in an earlier browser version. 1416 </dd> 1417 1418 <!-- OBJECT PROPERTIES --> 1419 <dd style="display: none; "> 1420 <dl> 1421 <div> 1422 <div> 1423 </div> 1424 </div> 1425 </dl> 1426 </dd> 1427 1428 <!-- OBJECT METHODS --> 1429 <dd style="display: none; "> 1430 <div></div> 1431 </dd> 1432 1433 <!-- OBJECT EVENT FIELDS --> 1434 <dd style="display: none; "> 1435 <div></div> 1436 </dd> 1437 1438 <!-- FUNCTION PARAMETERS --> 1439 <dd style="display: none; "> 1440 <div></div> 1441 </dd> 1442 1443 </div> 1444 </div><div> 1445 <div> 1446 <dt> 1447 <var>incognito</var> 1448 <em> 1449 1450 <!-- TYPE --> 1451 <div style="display:inline"> 1452 ( 1453 <span class="optional">optional</span> 1454 <span class="enum" style="display: none; ">enumerated</span> 1455 <span id="typeTemplate"> 1456 <span style="display: none; "> 1457 <a> Type</a> 1458 </span> 1459 <span> 1460 <span style="display: none; "> 1461 array of <span><span></span></span> 1462 </span> 1463 <span>boolean</span> 1464 <span style="display: none; "></span> 1465 </span> 1466 </span> 1467 ) 1468 </div> 1469 1470 </em> 1471 </dt> 1472 <dd class="todo" style="display: none; "> 1473 Undocumented. 1474 </dd> 1475 <dd>Whether to modify the setting for the incognito session only (default false).</dd> 1476 <dd style="display: none; "> 1477 This parameter was added in version 1478 <b><span></span></b>. 1479 You must omit this parameter in earlier versions, 1480 and you may omit it in any version. If you require this 1481 parameter, the manifest key 1482 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1483 can ensure that your extension won't be run in an earlier browser version. 1484 </dd> 1485 1486 <!-- OBJECT PROPERTIES --> 1487 <dd style="display: none; "> 1488 <dl> 1489 <div> 1490 <div> 1491 </div> 1492 </div> 1493 </dl> 1494 </dd> 1495 1496 <!-- OBJECT METHODS --> 1497 <dd style="display: none; "> 1498 <div></div> 1499 </dd> 1500 1501 <!-- OBJECT EVENT FIELDS --> 1502 <dd style="display: none; "> 1503 <div></div> 1504 </dd> 1505 1506 <!-- FUNCTION PARAMETERS --> 1507 <dd style="display: none; "> 1508 <div></div> 1509 </dd> 1510 1511 </div> 1512 </div> 1513 </dl> 1514 </dd> 1515 1516 <!-- OBJECT METHODS --> 1517 <dd style="display: none; "> 1518 <div></div> 1519 </dd> 1520 1521 <!-- OBJECT EVENT FIELDS --> 1522 <dd style="display: none; "> 1523 <div></div> 1524 </dd> 1525 1526 <!-- FUNCTION PARAMETERS --> 1527 <dd style="display: none; "> 1528 <div></div> 1529 </dd> 1530 1531 </div> 1532 </div><div> 1533 <div> 1534 <dt> 1535 <var>callback</var> 1536 <em> 1537 1538 <!-- TYPE --> 1539 <div style="display:inline"> 1540 ( 1541 <span class="optional">optional</span> 1542 <span class="enum" style="display: none; ">enumerated</span> 1543 <span id="typeTemplate"> 1544 <span style="display: none; "> 1545 <a> Type</a> 1546 </span> 1547 <span> 1548 <span style="display: none; "> 1549 array of <span><span></span></span> 1550 </span> 1551 <span>function</span> 1552 <span style="display: none; "></span> 1553 </span> 1554 </span> 1555 ) 1556 </div> 1557 1558 </em> 1559 </dt> 1560 <dd class="todo" style="display: none; "> 1561 Undocumented. 1562 </dd> 1563 <dd>Called after the preference has been set.</dd> 1564 <dd style="display: none; "> 1565 This parameter was added in version 1566 <b><span></span></b>. 1567 You must omit this parameter in earlier versions, 1568 and you may omit it in any version. If you require this 1569 parameter, the manifest key 1570 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1571 can ensure that your extension won't be run in an earlier browser version. 1572 </dd> 1573 1574 <!-- OBJECT PROPERTIES --> 1575 <dd style="display: none; "> 1576 <dl> 1577 <div> 1578 <div> 1579 </div> 1580 </div> 1581 </dl> 1582 </dd> 1583 1584 <!-- OBJECT METHODS --> 1585 <dd style="display: none; "> 1586 <div></div> 1587 </dd> 1588 1589 <!-- OBJECT EVENT FIELDS --> 1590 <dd style="display: none; "> 1591 <div></div> 1592 </dd> 1593 1594 <!-- FUNCTION PARAMETERS --> 1595 <dd style="display: none; "> 1596 <div></div> 1597 </dd> 1598 1599 </div> 1600 </div> 1601 </dl> 1602 1603 <!-- RETURNS --> 1604 <h4 style="display: none; ">Returns</h4> 1605 <dl> 1606 <div style="display: none; "> 1607 <div> 1608 </div> 1609 </div> 1610 </dl> 1611 1612 <!-- CALLBACK --> 1613 <div> 1614 <div> 1615 <h4>Callback function</h4> 1616 <p style="display: none; "> 1617 The callback <em>parameter</em> should specify a function 1618 that looks like this: 1619 </p> 1620 <p> 1621 If you specify the <em>callback</em> parameter, it should 1622 specify a function that looks like this: 1623 </p> 1624 1625 <!-- Note: intentionally longer 80 columns --> 1626 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 1627 <dl> 1628 <div style="display: none; "> 1629 <div> 1630 </div> 1631 </div> 1632 </dl> 1633 </div> 1634 </div> 1635 1636 <!-- MIN_VERSION --> 1637 <p style="display: none; "> 1638 This function was added in version <b><span></span></b>. 1639 If you require this function, the manifest key 1640 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1641 can ensure that your extension won't be run in an earlier browser version. 1642 </p> 1643 </div> <!-- /description --> 1644 1645 </div> <!-- /apiItem --> 1646 1647 </div> 1648 </dd> 1649 1650 <!-- OBJECT EVENT FIELDS --> 1651 <dd> 1652 <div class="apiGroup" style=""> 1653 <a name="global-Preference-events"></a> 1654 <h3>Events of Preference</h3> 1655 <!-- iterates over all events --> 1656 <div class="apiItem"> 1657 <a name="event-Preference-onChange"></a> 1658 <h4>onChange</h4> 1659 1660 <div class="summary"> 1661 <!-- Note: intentionally longer 80 columns --> 1662 <span class="subdued">preference.</span><span>onChange</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span>); 1663 </div> 1664 1665 <div class="description"> 1666 <p class="todo" style="display: none; ">Undocumented.</p> 1667 <p>Fired when the value of the preference changes.</p> 1668 1669 <!-- PARAMETERS --> 1670 <div> 1671 <h4>Parameters</h4> 1672 <dl> 1673 <div> 1674 <div> 1675 <dt> 1676 <var>details</var> 1677 <em> 1678 1679 <!-- TYPE --> 1680 <div style="display:inline"> 1681 ( 1682 <span class="optional" style="display: none; ">optional</span> 1683 <span class="enum" style="display: none; ">enumerated</span> 1684 <span id="typeTemplate"> 1685 <span style="display: none; "> 1686 <a> Type</a> 1687 </span> 1688 <span> 1689 <span style="display: none; "> 1690 array of <span><span></span></span> 1691 </span> 1692 <span>object</span> 1693 <span style="display: none; "></span> 1694 </span> 1695 </span> 1696 ) 1697 </div> 1698 1699 </em> 1700 </dt> 1701 <dd class="todo"> 1702 Undocumented. 1703 </dd> 1704 <dd style="display: none; "> 1705 Description of this parameter from the json schema. 1706 </dd> 1707 <dd style="display: none; "> 1708 This parameter was added in version 1709 <b><span></span></b>. 1710 You must omit this parameter in earlier versions, 1711 and you may omit it in any version. If you require this 1712 parameter, the manifest key 1713 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1714 can ensure that your extension won't be run in an earlier browser version. 1715 </dd> 1716 1717 <!-- OBJECT PROPERTIES --> 1718 <dd> 1719 <dl> 1720 <div> 1721 <div> 1722 <dt> 1723 <var>value</var> 1724 <em> 1725 1726 <!-- TYPE --> 1727 <div style="display:inline"> 1728 ( 1729 <span class="optional" style="display: none; ">optional</span> 1730 <span class="enum" style="display: none; ">enumerated</span> 1731 <span id="typeTemplate"> 1732 <span style="display: none; "> 1733 <a> Type</a> 1734 </span> 1735 <span> 1736 <span style="display: none; "> 1737 array of <span><span></span></span> 1738 </span> 1739 <span>any</span> 1740 <span style="display: none; "></span> 1741 </span> 1742 </span> 1743 ) 1744 </div> 1745 1746 </em> 1747 </dt> 1748 <dd class="todo" style="display: none; "> 1749 Undocumented. 1750 </dd> 1751 <dd>The value of the preference.</dd> 1752 <dd style="display: none; "> 1753 This parameter was added in version 1754 <b><span></span></b>. 1755 You must omit this parameter in earlier versions, 1756 and you may omit it in any version. If you require this 1757 parameter, the manifest key 1758 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1759 can ensure that your extension won't be run in an earlier browser version. 1760 </dd> 1761 1762 <!-- OBJECT PROPERTIES --> 1763 <dd style="display: none; "> 1764 <dl> 1765 <div> 1766 <div> 1767 </div> 1768 </div> 1769 </dl> 1770 </dd> 1771 1772 <!-- OBJECT METHODS --> 1773 <dd style="display: none; "> 1774 <div></div> 1775 </dd> 1776 1777 <!-- OBJECT EVENT FIELDS --> 1778 <dd style="display: none; "> 1779 <div></div> 1780 </dd> 1781 1782 <!-- FUNCTION PARAMETERS --> 1783 <dd style="display: none; "> 1784 <div></div> 1785 </dd> 1786 1787 </div> 1788 </div><div> 1789 <div> 1790 <dt> 1791 <var>levelOfControl</var> 1792 <em> 1793 1794 <!-- TYPE --> 1795 <div style="display:inline"> 1796 ( 1797 <span class="optional" style="display: none; ">optional</span> 1798 <span class="enum">enumerated</span> 1799 <span id="typeTemplate"> 1800 <span style="display: none; "> 1801 <a> Type</a> 1802 </span> 1803 <span> 1804 <span style="display: none; "> 1805 array of <span><span></span></span> 1806 </span> 1807 <span>string</span> 1808 <span>["NotControllable", "ControlledByOtherExtensions", "ControllableByThisExtension", "ControlledByThisExtension"]</span> 1809 </span> 1810 </span> 1811 ) 1812 </div> 1813 1814 </em> 1815 </dt> 1816 <dd class="todo" style="display: none; "> 1817 Undocumented. 1818 </dd> 1819 <dd>One of<br><var>NotControllable</var>: cannot be controlled by any extension<br><var>ControlledByOtherExtensions</var>: controlled by extensions with higher precedence<br><var>ControllableByThisExtension</var>: can be controlled by this extension<br><var>ControlledByThisExtension</var>: controlled by this extension</dd> 1820 <dd style="display: none; "> 1821 This parameter was added in version 1822 <b><span></span></b>. 1823 You must omit this parameter in earlier versions, 1824 and you may omit it in any version. If you require this 1825 parameter, the manifest key 1826 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1827 can ensure that your extension won't be run in an earlier browser version. 1828 </dd> 1829 1830 <!-- OBJECT PROPERTIES --> 1831 <dd style="display: none; "> 1832 <dl> 1833 <div> 1834 <div> 1835 </div> 1836 </div> 1837 </dl> 1838 </dd> 1839 1840 <!-- OBJECT METHODS --> 1841 <dd style="display: none; "> 1842 <div></div> 1843 </dd> 1844 1845 <!-- OBJECT EVENT FIELDS --> 1846 <dd style="display: none; "> 1847 <div></div> 1848 </dd> 1849 1850 <!-- FUNCTION PARAMETERS --> 1851 <dd style="display: none; "> 1852 <div></div> 1853 </dd> 1854 1855 </div> 1856 </div><div> 1857 <div> 1858 <dt> 1859 <var>incognitoSpecific</var> 1860 <em> 1861 1862 <!-- TYPE --> 1863 <div style="display:inline"> 1864 ( 1865 <span class="optional">optional</span> 1866 <span class="enum" style="display: none; ">enumerated</span> 1867 <span id="typeTemplate"> 1868 <span style="display: none; "> 1869 <a> Type</a> 1870 </span> 1871 <span> 1872 <span style="display: none; "> 1873 array of <span><span></span></span> 1874 </span> 1875 <span>boolean</span> 1876 <span style="display: none; "></span> 1877 </span> 1878 </span> 1879 ) 1880 </div> 1881 1882 </em> 1883 </dt> 1884 <dd class="todo" style="display: none; "> 1885 Undocumented. 1886 </dd> 1887 <dd>Whether the value that has changed is specific to the incognito session.<br>This property will <em>only</em> be present if the user has enabled the extension in incognito mode.</dd> 1888 <dd style="display: none; "> 1889 This parameter was added in version 1890 <b><span></span></b>. 1891 You must omit this parameter in earlier versions, 1892 and you may omit it in any version. If you require this 1893 parameter, the manifest key 1894 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1895 can ensure that your extension won't be run in an earlier browser version. 1896 </dd> 1897 1898 <!-- OBJECT PROPERTIES --> 1899 <dd style="display: none; "> 1900 <dl> 1901 <div> 1902 <div> 1903 </div> 1904 </div> 1905 </dl> 1906 </dd> 1907 1908 <!-- OBJECT METHODS --> 1909 <dd style="display: none; "> 1910 <div></div> 1911 </dd> 1912 1913 <!-- OBJECT EVENT FIELDS --> 1914 <dd style="display: none; "> 1915 <div></div> 1916 </dd> 1917 1918 <!-- FUNCTION PARAMETERS --> 1919 <dd style="display: none; "> 1920 <div></div> 1921 </dd> 1922 1923 </div> 1924 </div> 1925 </dl> 1926 </dd> 1927 1928 <!-- OBJECT METHODS --> 1929 <dd style="display: none; "> 1930 <div></div> 1931 </dd> 1932 1933 <!-- OBJECT EVENT FIELDS --> 1934 <dd style="display: none; "> 1935 <div></div> 1936 </dd> 1937 1938 <!-- FUNCTION PARAMETERS --> 1939 <dd style="display: none; "> 1940 <div></div> 1941 </dd> 1942 1943 </div> 1944 </div> 1945 </dl> 1946 </div> 1947 </div> <!-- /decription --> 1948 1949 </div> <!-- /apiItem --> 1950 1951 </div> 1952 </dd> 1953 1954 <!-- FUNCTION PARAMETERS --> 1955 <dd style="display: none; "> 1956 <div></div> 1957 </dd> 1958 1959 </div> 1960 1961 </div> <!-- /apiItem --> 1962 1963 </div> <!-- /apiGroup --> 1964 1965 </div> <!-- /apiPage --> 1966 </div> <!-- /gc-pagecontent --> 1967 </div> <!-- /g-section --> 1968 </div> <!-- /codesiteContent --> 1969 <div id="gc-footer" --=""> 1970 <div class="text"> 1971 <p> 1972 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 1973 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 1974 Attribution 3.0 License</a>, and code samples are licensed under the 1975 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 1976 </p> 1977 <p> 1978 ©2011 Google 1979 </p> 1980 1981<!-- begin analytics --> 1982<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 1983<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 1984 1985<script type="text/javascript"> 1986 // chrome doc tracking 1987 try { 1988 var engdocs = _gat._getTracker("YT-10763712-2"); 1989 engdocs._trackPageview(); 1990 } catch(err) {} 1991 1992 // code.google.com site-wide tracking 1993 try { 1994 _uacct="UA-18071-1"; 1995 _uanchor=1; 1996 _uff=0; 1997 urchinTracker(); 1998 } 1999 catch(e) {/* urchinTracker not available. */} 2000</script> 2001<!-- end analytics --> 2002 </div> 2003 </div> <!-- /gc-footer --> 2004 </div> <!-- /gc-container --> 2005</body></html> 2006
