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.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.extension</h1> 255 </div> 256 <!-- TABLE OF CONTENTS --> 257 <div id="toc"> 258 <h2>Contents</h2> 259 <ol> 260 <li> 261 <a href="#content scripts">Support for content scripts</a> 262 <ol> 263 <li style="display: none; "> 264 <a>h3Name</a> 265 </li> 266 </ol> 267 </li> 268 <li> 269 <a href="#apiReference">API reference: chrome.extension</a> 270 <ol> 271 <li> 272 <a href="#properties">Properties</a> 273 <ol> 274 <li> 275 <a href="#property-lastError">lastError</a> 276 </li><li> 277 <a href="#property-inIncognitoContext">inIncognitoContext</a> 278 </li> 279 </ol> 280 </li> 281 <li> 282 <a href="#global-methods">Methods</a> 283 <ol> 284 <li> 285 <a href="#method-connect">connect</a> 286 </li><li> 287 <a href="#method-getBackgroundPage">getBackgroundPage</a> 288 </li><li style="display: none; "> 289 <a href="#method-anchor">methodName</a> 290 </li><li style="display: none; "> 291 <a href="#method-anchor">methodName</a> 292 </li><li> 293 <a href="#method-getURL">getURL</a> 294 </li><li> 295 <a href="#method-getViews">getViews</a> 296 </li><li> 297 <a href="#method-isAllowedFileSchemeAccess">isAllowedFileSchemeAccess</a> 298 </li><li> 299 <a href="#method-isAllowedIncognitoAccess">isAllowedIncognitoAccess</a> 300 </li><li> 301 <a href="#method-sendRequest">sendRequest</a> 302 </li><li> 303 <a href="#method-setUpdateUrlData">setUpdateUrlData</a> 304 </li> 305 </ol> 306 </li> 307 <li> 308 <a href="#global-events">Events</a> 309 <ol> 310 <li> 311 <a href="#event-onConnect">onConnect</a> 312 </li><li> 313 <a href="#event-onConnectExternal">onConnectExternal</a> 314 </li><li> 315 <a href="#event-onRequest">onRequest</a> 316 </li><li> 317 <a href="#event-onRequestExternal">onRequestExternal</a> 318 </li> 319 </ol> 320 </li> 321 <li> 322 <a href="#types">Types</a> 323 <ol> 324 <li> 325 <a href="#type-MessageSender">MessageSender</a> 326 </li><li> 327 <a href="#type-Event">Event</a> 328 </li><li> 329 <a href="#type-Port">Port</a> 330 </li> 331 </ol> 332 </li> 333 </ol> 334 </li> 335 </ol> 336 </div> 337 <!-- /TABLE OF CONTENTS --> 338 339 <!-- Standard content lead-in for experimental API pages --> 340 <p id="classSummary" style="display: none; "> 341 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 342 </p> 343 344 <!-- STATIC CONTENT PLACEHOLDER --> 345 <div id="static"><!-- BEGIN AUTHORED CONTENT --> 346 <p id="classSummary"> 347 The <code>chrome.extension</code> module 348 has utilities that can be used by any extension page. 349 It includes support for exchanging messages 350 between an extension and its content scripts 351 or between extensions, 352 as described in detail in 353 <a href="messaging.html">Message Passing</a>. 354 </p> 355 356 <h2 id="content scripts">Support for content scripts</h2> 357 <p> 358 Unlike the other chrome.* APIs, 359 parts of <code>chrome.extension</code> 360 can be used by content scripts: 361 </p> 362 363 <dl> 364 <dt> 365 <a href="#method-sendRequest"><code>sendRequest()</code></a> and 366 <a href="#event-onRequest"><code>onRequest</code></a> 367 </dt> 368 <dd> 369 Simple communication with extension pages 370 </dd> 371 <dt> 372 <a href="#method-connect"><code>connect()</code></a> and 373 <a href="#event-onConnect"><code>onConnect</code></a> 374 </dt> 375 <dd> 376 Extended communication with extension pages 377 </dd> 378 <dt> 379 <a href="#method-getURL"><code>getURL()</code></a> 380 </dt> 381 <dd> 382 Access to extension resources such as image files 383 </dd> 384 </dl> 385 386 <p> 387 For details, see 388 <a href="content_scripts.html">Content Scripts</a>. 389 </p> 390 391 <!-- END AUTHORED CONTENT --> 392 </div> 393 394 <!-- API PAGE --> 395 <div class="apiPage"> 396 <a name="apiReference"></a> 397 <h2>API reference: chrome.extension</h2> 398 399 <!-- PROPERTIES --> 400 <div class="apiGroup"> 401 <a name="properties"></a> 402 <h3 id="properties">Properties</h3> 403 404 <div> 405 <a name="property-lastError"></a> 406 <h4>lastError</h4> 407 <div class="summary"> 408 <!-- Note: intentionally longer 80 columns --> 409 <span>chrome.extension.</span><span>lastError</span> 410 </div> 411 <div> 412 <dt> 413 <var>lastError</var> 414 <em> 415 416 <!-- TYPE --> 417 <div style="display:inline"> 418 ( 419 <span class="optional">optional</span> 420 <span class="enum" style="display: none; ">enumerated</span> 421 <span id="typeTemplate"> 422 <span style="display: none; "> 423 <a> Type</a> 424 </span> 425 <span> 426 <span style="display: none; "> 427 array of <span><span></span></span> 428 </span> 429 <span>object</span> 430 <span style="display: none; "></span> 431 </span> 432 </span> 433 ) 434 </div> 435 436 </em> 437 </dt> 438 <dd class="todo" style="display: none; "> 439 Undocumented. 440 </dd> 441 <dd>Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be <var>undefined</var>.</dd> 442 <dd style="display: none; "> 443 This parameter was added in version 444 <b><span></span></b>. 445 You must omit this parameter in earlier versions, 446 and you may omit it in any version. If you require this 447 parameter, the manifest key 448 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 449 can ensure that your extension won't be run in an earlier browser version. 450 </dd> 451 452 <!-- OBJECT PROPERTIES --> 453 <dd> 454 <dl> 455 <div> 456 <div> 457 <dt> 458 <var>message</var> 459 <em> 460 461 <!-- TYPE --> 462 <div style="display:inline"> 463 ( 464 <span class="optional" style="display: none; ">optional</span> 465 <span class="enum" style="display: none; ">enumerated</span> 466 <span id="typeTemplate"> 467 <span style="display: none; "> 468 <a> Type</a> 469 </span> 470 <span> 471 <span style="display: none; "> 472 array of <span><span></span></span> 473 </span> 474 <span>string</span> 475 <span style="display: none; "></span> 476 </span> 477 </span> 478 ) 479 </div> 480 481 </em> 482 </dt> 483 <dd class="todo" style="display: none; "> 484 Undocumented. 485 </dd> 486 <dd>Description of the error that has taken place.</dd> 487 <dd style="display: none; "> 488 This parameter was added in version 489 <b><span></span></b>. 490 You must omit this parameter in earlier versions, 491 and you may omit it in any version. If you require this 492 parameter, the manifest key 493 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 494 can ensure that your extension won't be run in an earlier browser version. 495 </dd> 496 497 <!-- OBJECT PROPERTIES --> 498 <dd style="display: none; "> 499 <dl> 500 <div> 501 <div> 502 </div> 503 </div> 504 </dl> 505 </dd> 506 507 <!-- OBJECT METHODS --> 508 <dd style="display: none; "> 509 <div></div> 510 </dd> 511 512 <!-- OBJECT EVENT FIELDS --> 513 <dd style="display: none; "> 514 <div></div> 515 </dd> 516 517 <!-- FUNCTION PARAMETERS --> 518 <dd style="display: none; "> 519 <div></div> 520 </dd> 521 522 </div> 523 </div> 524 </dl> 525 </dd> 526 527 <!-- OBJECT METHODS --> 528 <dd style="display: none; "> 529 <div></div> 530 </dd> 531 532 <!-- OBJECT EVENT FIELDS --> 533 <dd style="display: none; "> 534 <div></div> 535 </dd> 536 537 <!-- FUNCTION PARAMETERS --> 538 <dd style="display: none; "> 539 <div></div> 540 </dd> 541 542 </div> 543 </div><div> 544 <a name="property-inIncognitoContext"></a> 545 <h4>inIncognitoContext</h4> 546 <div class="summary"> 547 <!-- Note: intentionally longer 80 columns --> 548 <span>chrome.extension.</span><span>inIncognitoContext</span> 549 </div> 550 <div> 551 <dt> 552 <var>inIncognitoContext</var> 553 <em> 554 555 <!-- TYPE --> 556 <div style="display:inline"> 557 ( 558 <span class="optional">optional</span> 559 <span class="enum" style="display: none; ">enumerated</span> 560 <span id="typeTemplate"> 561 <span style="display: none; "> 562 <a> Type</a> 563 </span> 564 <span> 565 <span style="display: none; "> 566 array of <span><span></span></span> 567 </span> 568 <span>object</span> 569 <span style="display: none; "></span> 570 </span> 571 </span> 572 ) 573 </div> 574 575 </em> 576 </dt> 577 <dd class="todo" style="display: none; "> 578 Undocumented. 579 </dd> 580 <dd>True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. The latter only applies to extensions with 'split' incognito_behavior.</dd> 581 <dd style="display: none; "> 582 This parameter was added in version 583 <b><span></span></b>. 584 You must omit this parameter in earlier versions, 585 and you may omit it in any version. If you require this 586 parameter, the manifest key 587 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 588 can ensure that your extension won't be run in an earlier browser version. 589 </dd> 590 591 <!-- OBJECT PROPERTIES --> 592 <dd> 593 <dl> 594 <div> 595 <div> 596 <dt> 597 <var>message</var> 598 <em> 599 600 <!-- TYPE --> 601 <div style="display:inline"> 602 ( 603 <span class="optional" style="display: none; ">optional</span> 604 <span class="enum" style="display: none; ">enumerated</span> 605 <span id="typeTemplate"> 606 <span style="display: none; "> 607 <a> Type</a> 608 </span> 609 <span> 610 <span style="display: none; "> 611 array of <span><span></span></span> 612 </span> 613 <span>boolean</span> 614 <span style="display: none; "></span> 615 </span> 616 </span> 617 ) 618 </div> 619 620 </em> 621 </dt> 622 <dd class="todo" style="display: none; "> 623 Undocumented. 624 </dd> 625 <dd>True if the page or script is in an incongito process.</dd> 626 <dd style="display: none; "> 627 This parameter was added in version 628 <b><span></span></b>. 629 You must omit this parameter in earlier versions, 630 and you may omit it in any version. If you require this 631 parameter, the manifest key 632 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 633 can ensure that your extension won't be run in an earlier browser version. 634 </dd> 635 636 <!-- OBJECT PROPERTIES --> 637 <dd style="display: none; "> 638 <dl> 639 <div> 640 <div> 641 </div> 642 </div> 643 </dl> 644 </dd> 645 646 <!-- OBJECT METHODS --> 647 <dd style="display: none; "> 648 <div></div> 649 </dd> 650 651 <!-- OBJECT EVENT FIELDS --> 652 <dd style="display: none; "> 653 <div></div> 654 </dd> 655 656 <!-- FUNCTION PARAMETERS --> 657 <dd style="display: none; "> 658 <div></div> 659 </dd> 660 661 </div> 662 </div> 663 </dl> 664 </dd> 665 666 <!-- OBJECT METHODS --> 667 <dd style="display: none; "> 668 <div></div> 669 </dd> 670 671 <!-- OBJECT EVENT FIELDS --> 672 <dd style="display: none; "> 673 <div></div> 674 </dd> 675 676 <!-- FUNCTION PARAMETERS --> 677 <dd style="display: none; "> 678 <div></div> 679 </dd> 680 681 </div> 682 </div> 683 684 </div> <!-- /apiGroup --> 685 686 <!-- METHODS --> 687 <div id="methodsTemplate" class="apiGroup"> 688 <a name="global-methods"></a> 689 <h3>Methods</h3> 690 691 <!-- iterates over all functions --> 692 <div class="apiItem"> 693 <a name="method-connect"></a> <!-- method-anchor --> 694 <h4>connect</h4> 695 696 <div class="summary"><span>Port</span> 697 <!-- Note: intentionally longer 80 columns --> 698 <span>chrome.extension.connect</span>(<span class="optional"><span style="display: none; ">, </span><span>string</span> 699 <var><span>extensionId</span></var></span><span class="optional"><span>, </span><span>object</span> 700 <var><span>connectInfo</span></var></span>)</div> 701 702 <div class="description"> 703 <p class="todo" style="display: none; ">Undocumented.</p> 704 <p>Attempts to connect to other listeners within the extension (such as the extension's background page). This is primarily useful for content scripts connecting to their extension processes. Extensions may connect to content scripts embedded in tabs via <a href="tabs.html#method-connect"><code>chrome.tabs.connect()</code></a>.</p> 705 706 <!-- PARAMETERS --> 707 <h4>Parameters</h4> 708 <dl> 709 <div> 710 <div> 711 <dt> 712 <var>extensionId</var> 713 <em> 714 715 <!-- TYPE --> 716 <div style="display:inline"> 717 ( 718 <span class="optional">optional</span> 719 <span class="enum" style="display: none; ">enumerated</span> 720 <span id="typeTemplate"> 721 <span style="display: none; "> 722 <a> Type</a> 723 </span> 724 <span> 725 <span style="display: none; "> 726 array of <span><span></span></span> 727 </span> 728 <span>string</span> 729 <span style="display: none; "></span> 730 </span> 731 </span> 732 ) 733 </div> 734 735 </em> 736 </dt> 737 <dd class="todo" style="display: none; "> 738 Undocumented. 739 </dd> 740 <dd>The extension ID of the extension you want to connect to. If omitted, default is your own extension.</dd> 741 <dd style="display: none; "> 742 This parameter was added in version 743 <b><span></span></b>. 744 You must omit this parameter in earlier versions, 745 and you may omit it in any version. If you require this 746 parameter, the manifest key 747 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 748 can ensure that your extension won't be run in an earlier browser version. 749 </dd> 750 751 <!-- OBJECT PROPERTIES --> 752 <dd style="display: none; "> 753 <dl> 754 <div> 755 <div> 756 </div> 757 </div> 758 </dl> 759 </dd> 760 761 <!-- OBJECT METHODS --> 762 <dd style="display: none; "> 763 <div></div> 764 </dd> 765 766 <!-- OBJECT EVENT FIELDS --> 767 <dd style="display: none; "> 768 <div></div> 769 </dd> 770 771 <!-- FUNCTION PARAMETERS --> 772 <dd style="display: none; "> 773 <div></div> 774 </dd> 775 776 </div> 777 </div><div> 778 <div> 779 <dt> 780 <var>connectInfo</var> 781 <em> 782 783 <!-- TYPE --> 784 <div style="display:inline"> 785 ( 786 <span class="optional">optional</span> 787 <span class="enum" style="display: none; ">enumerated</span> 788 <span id="typeTemplate"> 789 <span style="display: none; "> 790 <a> Type</a> 791 </span> 792 <span> 793 <span style="display: none; "> 794 array of <span><span></span></span> 795 </span> 796 <span>object</span> 797 <span style="display: none; "></span> 798 </span> 799 </span> 800 ) 801 </div> 802 803 </em> 804 </dt> 805 <dd class="todo"> 806 Undocumented. 807 </dd> 808 <dd style="display: none; "> 809 Description of this parameter from the json schema. 810 </dd> 811 <dd style="display: none; "> 812 This parameter was added in version 813 <b><span></span></b>. 814 You must omit this parameter in earlier versions, 815 and you may omit it in any version. If you require this 816 parameter, the manifest key 817 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 818 can ensure that your extension won't be run in an earlier browser version. 819 </dd> 820 821 <!-- OBJECT PROPERTIES --> 822 <dd> 823 <dl> 824 <div> 825 <div> 826 <dt> 827 <var>name</var> 828 <em> 829 830 <!-- TYPE --> 831 <div style="display:inline"> 832 ( 833 <span class="optional">optional</span> 834 <span class="enum" style="display: none; ">enumerated</span> 835 <span id="typeTemplate"> 836 <span style="display: none; "> 837 <a> Type</a> 838 </span> 839 <span> 840 <span style="display: none; "> 841 array of <span><span></span></span> 842 </span> 843 <span>string</span> 844 <span style="display: none; "></span> 845 </span> 846 </span> 847 ) 848 </div> 849 850 </em> 851 </dt> 852 <dd class="todo" style="display: none; "> 853 Undocumented. 854 </dd> 855 <dd>Will be passed into onConnect for extension processes that are listening for the connection event.</dd> 856 <dd style="display: none; "> 857 This parameter was added in version 858 <b><span></span></b>. 859 You must omit this parameter in earlier versions, 860 and you may omit it in any version. If you require this 861 parameter, the manifest key 862 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 863 can ensure that your extension won't be run in an earlier browser version. 864 </dd> 865 866 <!-- OBJECT PROPERTIES --> 867 <dd style="display: none; "> 868 <dl> 869 <div> 870 <div> 871 </div> 872 </div> 873 </dl> 874 </dd> 875 876 <!-- OBJECT METHODS --> 877 <dd style="display: none; "> 878 <div></div> 879 </dd> 880 881 <!-- OBJECT EVENT FIELDS --> 882 <dd style="display: none; "> 883 <div></div> 884 </dd> 885 886 <!-- FUNCTION PARAMETERS --> 887 <dd style="display: none; "> 888 <div></div> 889 </dd> 890 891 </div> 892 </div> 893 </dl> 894 </dd> 895 896 <!-- OBJECT METHODS --> 897 <dd style="display: none; "> 898 <div></div> 899 </dd> 900 901 <!-- OBJECT EVENT FIELDS --> 902 <dd style="display: none; "> 903 <div></div> 904 </dd> 905 906 <!-- FUNCTION PARAMETERS --> 907 <dd style="display: none; "> 908 <div></div> 909 </dd> 910 911 </div> 912 </div> 913 </dl> 914 915 <!-- RETURNS --> 916 <h4>Returns</h4> 917 <dl> 918 <div> 919 <div> 920 <dt> 921 <var style="display: none; ">paramName</var> 922 <em> 923 924 <!-- TYPE --> 925 <div style="display:inline"> 926 ( 927 <span class="optional" style="display: none; ">optional</span> 928 <span class="enum" style="display: none; ">enumerated</span> 929 <span id="typeTemplate"> 930 <span> 931 <a href="extension.html#type-Port">Port</a> 932 </span> 933 <span style="display: none; "> 934 <span> 935 array of <span><span></span></span> 936 </span> 937 <span>paramType</span> 938 <span></span> 939 </span> 940 </span> 941 ) 942 </div> 943 944 </em> 945 </dt> 946 <dd class="todo" style="display: none; "> 947 Undocumented. 948 </dd> 949 <dd>Port through which messages can be sent and received with the extension. The port's <a href="extension.html#type-Port">onDisconnect</a> event is fired if extension does not exist. </dd> 950 <dd style="display: none; "> 951 This parameter was added in version 952 <b><span></span></b>. 953 You must omit this parameter in earlier versions, 954 and you may omit it in any version. If you require this 955 parameter, the manifest key 956 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 957 can ensure that your extension won't be run in an earlier browser version. 958 </dd> 959 960 <!-- OBJECT PROPERTIES --> 961 <dd style="display: none; "> 962 <dl> 963 <div> 964 <div> 965 </div> 966 </div> 967 </dl> 968 </dd> 969 970 <!-- OBJECT METHODS --> 971 <dd style="display: none; "> 972 <div></div> 973 </dd> 974 975 <!-- OBJECT EVENT FIELDS --> 976 <dd style="display: none; "> 977 <div></div> 978 </dd> 979 980 <!-- FUNCTION PARAMETERS --> 981 <dd style="display: none; "> 982 <div></div> 983 </dd> 984 985 </div> 986 </div> 987 </dl> 988 989 <!-- CALLBACK --> 990 <div style="display: none; "> 991 <div> 992 <h4>Callback function</h4> 993 <p> 994 The callback <em>parameter</em> should specify a function 995 that looks like this: 996 </p> 997 <p> 998 If you specify the <em>callback</em> parameter, it should 999 specify a function that looks like this: 1000 </p> 1001 1002 <!-- Note: intentionally longer 80 columns --> 1003 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1004 <dl> 1005 <div> 1006 <div> 1007 </div> 1008 </div> 1009 </dl> 1010 </div> 1011 </div> 1012 1013 <!-- MIN_VERSION --> 1014 <p style="display: none; "> 1015 This function was added in version <b><span></span></b>. 1016 If you require this function, the manifest key 1017 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1018 can ensure that your extension won't be run in an earlier browser version. 1019 </p> 1020 </div> <!-- /description --> 1021 1022 </div><div class="apiItem"> 1023 <a name="method-getBackgroundPage"></a> <!-- method-anchor --> 1024 <h4>getBackgroundPage</h4> 1025 1026 <div class="summary"><span>DOMWindow</span> 1027 <!-- Note: intentionally longer 80 columns --> 1028 <span>chrome.extension.getBackgroundPage</span>(<span style="display: none; "><span>, </span><span></span> 1029 <var><span></span></var></span>)</div> 1030 1031 <div class="description"> 1032 <p class="todo" style="display: none; ">Undocumented.</p> 1033 <p>Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.</p> 1034 1035 <!-- PARAMETERS --> 1036 <h4 style="display: none; ">Parameters</h4> 1037 <dl> 1038 <div style="display: none; "> 1039 <div> 1040 </div> 1041 </div> 1042 </dl> 1043 1044 <!-- RETURNS --> 1045 <h4>Returns</h4> 1046 <dl> 1047 <div> 1048 <div> 1049 <dt> 1050 <var style="display: none; ">paramName</var> 1051 <em> 1052 1053 <!-- TYPE --> 1054 <div style="display:inline"> 1055 ( 1056 <span class="optional" style="display: none; ">optional</span> 1057 <span class="enum" style="display: none; ">enumerated</span> 1058 <span id="typeTemplate"> 1059 <span style="display: none; "> 1060 <a> Type</a> 1061 </span> 1062 <span> 1063 <span style="display: none; "> 1064 array of <span><span></span></span> 1065 </span> 1066 <span>DOMWindow</span> 1067 <span style="display: none; "></span> 1068 </span> 1069 </span> 1070 ) 1071 </div> 1072 1073 </em> 1074 </dt> 1075 <dd class="todo"> 1076 Undocumented. 1077 </dd> 1078 <dd style="display: none; "> 1079 Description of this parameter from the json schema. 1080 </dd> 1081 <dd style="display: none; "> 1082 This parameter was added in version 1083 <b><span></span></b>. 1084 You must omit this parameter in earlier versions, 1085 and you may omit it in any version. If you require this 1086 parameter, the manifest key 1087 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1088 can ensure that your extension won't be run in an earlier browser version. 1089 </dd> 1090 1091 <!-- OBJECT PROPERTIES --> 1092 <dd> 1093 <dl> 1094 <div style="display: none; "> 1095 <div> 1096 </div> 1097 </div> 1098 </dl> 1099 </dd> 1100 1101 <!-- OBJECT METHODS --> 1102 <dd style="display: none; "> 1103 <div></div> 1104 </dd> 1105 1106 <!-- OBJECT EVENT FIELDS --> 1107 <dd style="display: none; "> 1108 <div></div> 1109 </dd> 1110 1111 <!-- FUNCTION PARAMETERS --> 1112 <dd style="display: none; "> 1113 <div></div> 1114 </dd> 1115 1116 </div> 1117 </div> 1118 </dl> 1119 1120 <!-- CALLBACK --> 1121 <div style="display: none; "> 1122 <div> 1123 <h4>Callback function</h4> 1124 <p> 1125 The callback <em>parameter</em> should specify a function 1126 that looks like this: 1127 </p> 1128 <p> 1129 If you specify the <em>callback</em> parameter, it should 1130 specify a function that looks like this: 1131 </p> 1132 1133 <!-- Note: intentionally longer 80 columns --> 1134 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1135 <dl> 1136 <div> 1137 <div> 1138 </div> 1139 </div> 1140 </dl> 1141 </div> 1142 </div> 1143 1144 <!-- MIN_VERSION --> 1145 <p style="display: none; "> 1146 This function was added in version <b><span></span></b>. 1147 If you require this function, the manifest key 1148 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1149 can ensure that your extension won't be run in an earlier browser version. 1150 </p> 1151 </div> <!-- /description --> 1152 1153 </div><div class="apiItem" style="display: none; "> 1154 <a></a> <!-- method-anchor --> 1155 <h4>method name</h4> 1156 1157 <div class="summary"><span>void</span> 1158 <!-- Note: intentionally longer 80 columns --> 1159 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 1160 <var><span></span></var></span>)</div> 1161 1162 <div class="description"> 1163 <p class="todo">Undocumented.</p> 1164 <p> 1165 A description from the json schema def of the function goes here. 1166 </p> 1167 1168 <!-- PARAMETERS --> 1169 <h4>Parameters</h4> 1170 <dl> 1171 <div> 1172 <div> 1173 </div> 1174 </div> 1175 </dl> 1176 1177 <!-- RETURNS --> 1178 <h4>Returns</h4> 1179 <dl> 1180 <div> 1181 <div> 1182 </div> 1183 </div> 1184 </dl> 1185 1186 <!-- CALLBACK --> 1187 <div> 1188 <div> 1189 <h4>Callback function</h4> 1190 <p> 1191 The callback <em>parameter</em> should specify a function 1192 that looks like this: 1193 </p> 1194 <p> 1195 If you specify the <em>callback</em> parameter, it should 1196 specify a function that looks like this: 1197 </p> 1198 1199 <!-- Note: intentionally longer 80 columns --> 1200 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1201 <dl> 1202 <div> 1203 <div> 1204 </div> 1205 </div> 1206 </dl> 1207 </div> 1208 </div> 1209 1210 <!-- MIN_VERSION --> 1211 <p> 1212 This function was added in version <b><span></span></b>. 1213 If you require this function, the manifest key 1214 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1215 can ensure that your extension won't be run in an earlier browser version. 1216 </p> 1217 </div> <!-- /description --> 1218 1219 </div><div class="apiItem" style="display: none; "> 1220 <a></a> <!-- method-anchor --> 1221 <h4>method name</h4> 1222 1223 <div class="summary"><span>void</span> 1224 <!-- Note: intentionally longer 80 columns --> 1225 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 1226 <var><span></span></var></span>)</div> 1227 1228 <div class="description"> 1229 <p class="todo">Undocumented.</p> 1230 <p> 1231 A description from the json schema def of the function goes here. 1232 </p> 1233 1234 <!-- PARAMETERS --> 1235 <h4>Parameters</h4> 1236 <dl> 1237 <div> 1238 <div> 1239 </div> 1240 </div> 1241 </dl> 1242 1243 <!-- RETURNS --> 1244 <h4>Returns</h4> 1245 <dl> 1246 <div> 1247 <div> 1248 </div> 1249 </div> 1250 </dl> 1251 1252 <!-- CALLBACK --> 1253 <div> 1254 <div> 1255 <h4>Callback function</h4> 1256 <p> 1257 The callback <em>parameter</em> should specify a function 1258 that looks like this: 1259 </p> 1260 <p> 1261 If you specify the <em>callback</em> parameter, it should 1262 specify a function that looks like this: 1263 </p> 1264 1265 <!-- Note: intentionally longer 80 columns --> 1266 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1267 <dl> 1268 <div> 1269 <div> 1270 </div> 1271 </div> 1272 </dl> 1273 </div> 1274 </div> 1275 1276 <!-- MIN_VERSION --> 1277 <p> 1278 This function was added in version <b><span></span></b>. 1279 If you require this function, the manifest key 1280 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1281 can ensure that your extension won't be run in an earlier browser version. 1282 </p> 1283 </div> <!-- /description --> 1284 1285 </div><div class="apiItem"> 1286 <a name="method-getURL"></a> <!-- method-anchor --> 1287 <h4>getURL</h4> 1288 1289 <div class="summary"><span>string</span> 1290 <!-- Note: intentionally longer 80 columns --> 1291 <span>chrome.extension.getURL</span>(<span class="null"><span style="display: none; ">, </span><span>string</span> 1292 <var><span>path</span></var></span>)</div> 1293 1294 <div class="description"> 1295 <p class="todo" style="display: none; ">Undocumented.</p> 1296 <p>Converts a relative path within an extension install directory to a fully-qualified URL.</p> 1297 1298 <!-- PARAMETERS --> 1299 <h4>Parameters</h4> 1300 <dl> 1301 <div> 1302 <div> 1303 <dt> 1304 <var>path</var> 1305 <em> 1306 1307 <!-- TYPE --> 1308 <div style="display:inline"> 1309 ( 1310 <span class="optional" style="display: none; ">optional</span> 1311 <span class="enum" style="display: none; ">enumerated</span> 1312 <span id="typeTemplate"> 1313 <span style="display: none; "> 1314 <a> Type</a> 1315 </span> 1316 <span> 1317 <span style="display: none; "> 1318 array of <span><span></span></span> 1319 </span> 1320 <span>string</span> 1321 <span style="display: none; "></span> 1322 </span> 1323 </span> 1324 ) 1325 </div> 1326 1327 </em> 1328 </dt> 1329 <dd class="todo" style="display: none; "> 1330 Undocumented. 1331 </dd> 1332 <dd>A path to a resource within an extension expressed relative to its install directory.</dd> 1333 <dd style="display: none; "> 1334 This parameter was added in version 1335 <b><span></span></b>. 1336 You must omit this parameter in earlier versions, 1337 and you may omit it in any version. If you require this 1338 parameter, the manifest key 1339 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1340 can ensure that your extension won't be run in an earlier browser version. 1341 </dd> 1342 1343 <!-- OBJECT PROPERTIES --> 1344 <dd style="display: none; "> 1345 <dl> 1346 <div> 1347 <div> 1348 </div> 1349 </div> 1350 </dl> 1351 </dd> 1352 1353 <!-- OBJECT METHODS --> 1354 <dd style="display: none; "> 1355 <div></div> 1356 </dd> 1357 1358 <!-- OBJECT EVENT FIELDS --> 1359 <dd style="display: none; "> 1360 <div></div> 1361 </dd> 1362 1363 <!-- FUNCTION PARAMETERS --> 1364 <dd style="display: none; "> 1365 <div></div> 1366 </dd> 1367 1368 </div> 1369 </div> 1370 </dl> 1371 1372 <!-- RETURNS --> 1373 <h4>Returns</h4> 1374 <dl> 1375 <div> 1376 <div> 1377 <dt> 1378 <var style="display: none; ">paramName</var> 1379 <em> 1380 1381 <!-- TYPE --> 1382 <div style="display:inline"> 1383 ( 1384 <span class="optional" style="display: none; ">optional</span> 1385 <span class="enum" style="display: none; ">enumerated</span> 1386 <span id="typeTemplate"> 1387 <span style="display: none; "> 1388 <a> Type</a> 1389 </span> 1390 <span> 1391 <span style="display: none; "> 1392 array of <span><span></span></span> 1393 </span> 1394 <span>string</span> 1395 <span style="display: none; "></span> 1396 </span> 1397 </span> 1398 ) 1399 </div> 1400 1401 </em> 1402 </dt> 1403 <dd class="todo" style="display: none; "> 1404 Undocumented. 1405 </dd> 1406 <dd>The fully-qualified URL to the resource.</dd> 1407 <dd style="display: none; "> 1408 This parameter was added in version 1409 <b><span></span></b>. 1410 You must omit this parameter in earlier versions, 1411 and you may omit it in any version. If you require this 1412 parameter, the manifest key 1413 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1414 can ensure that your extension won't be run in an earlier browser version. 1415 </dd> 1416 1417 <!-- OBJECT PROPERTIES --> 1418 <dd style="display: none; "> 1419 <dl> 1420 <div> 1421 <div> 1422 </div> 1423 </div> 1424 </dl> 1425 </dd> 1426 1427 <!-- OBJECT METHODS --> 1428 <dd style="display: none; "> 1429 <div></div> 1430 </dd> 1431 1432 <!-- OBJECT EVENT FIELDS --> 1433 <dd style="display: none; "> 1434 <div></div> 1435 </dd> 1436 1437 <!-- FUNCTION PARAMETERS --> 1438 <dd style="display: none; "> 1439 <div></div> 1440 </dd> 1441 1442 </div> 1443 </div> 1444 </dl> 1445 1446 <!-- CALLBACK --> 1447 <div style="display: none; "> 1448 <div> 1449 <h4>Callback function</h4> 1450 <p> 1451 The callback <em>parameter</em> should specify a function 1452 that looks like this: 1453 </p> 1454 <p> 1455 If you specify the <em>callback</em> parameter, it should 1456 specify a function that looks like this: 1457 </p> 1458 1459 <!-- Note: intentionally longer 80 columns --> 1460 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1461 <dl> 1462 <div> 1463 <div> 1464 </div> 1465 </div> 1466 </dl> 1467 </div> 1468 </div> 1469 1470 <!-- MIN_VERSION --> 1471 <p style="display: none; "> 1472 This function was added in version <b><span></span></b>. 1473 If you require this function, the manifest key 1474 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1475 can ensure that your extension won't be run in an earlier browser version. 1476 </p> 1477 </div> <!-- /description --> 1478 1479 </div><div class="apiItem"> 1480 <a name="method-getViews"></a> <!-- method-anchor --> 1481 <h4>getViews</h4> 1482 1483 <div class="summary"><span>array of DOMWindow</span> 1484 <!-- Note: intentionally longer 80 columns --> 1485 <span>chrome.extension.getViews</span>(<span class="optional"><span style="display: none; ">, </span><span>object</span> 1486 <var><span>fetchProperties</span></var></span>)</div> 1487 1488 <div class="description"> 1489 <p class="todo" style="display: none; ">Undocumented.</p> 1490 <p>Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.</p> 1491 1492 <!-- PARAMETERS --> 1493 <h4>Parameters</h4> 1494 <dl> 1495 <div> 1496 <div> 1497 <dt> 1498 <var>fetchProperties</var> 1499 <em> 1500 1501 <!-- TYPE --> 1502 <div style="display:inline"> 1503 ( 1504 <span class="optional">optional</span> 1505 <span class="enum" style="display: none; ">enumerated</span> 1506 <span id="typeTemplate"> 1507 <span style="display: none; "> 1508 <a> Type</a> 1509 </span> 1510 <span> 1511 <span style="display: none; "> 1512 array of <span><span></span></span> 1513 </span> 1514 <span>object</span> 1515 <span style="display: none; "></span> 1516 </span> 1517 </span> 1518 ) 1519 </div> 1520 1521 </em> 1522 </dt> 1523 <dd class="todo"> 1524 Undocumented. 1525 </dd> 1526 <dd style="display: none; "> 1527 Description of this parameter from the json schema. 1528 </dd> 1529 <dd style="display: none; "> 1530 This parameter was added in version 1531 <b><span></span></b>. 1532 You must omit this parameter in earlier versions, 1533 and you may omit it in any version. If you require this 1534 parameter, the manifest key 1535 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1536 can ensure that your extension won't be run in an earlier browser version. 1537 </dd> 1538 1539 <!-- OBJECT PROPERTIES --> 1540 <dd> 1541 <dl> 1542 <div> 1543 <div> 1544 <dt> 1545 <var>type</var> 1546 <em> 1547 1548 <!-- TYPE --> 1549 <div style="display:inline"> 1550 ( 1551 <span class="optional">optional</span> 1552 <span class="enum">enumerated</span> 1553 <span id="typeTemplate"> 1554 <span style="display: none; "> 1555 <a> Type</a> 1556 </span> 1557 <span> 1558 <span style="display: none; "> 1559 array of <span><span></span></span> 1560 </span> 1561 <span>string</span> 1562 <span>["tab", "infobar", "notification", "popup"]</span> 1563 </span> 1564 </span> 1565 ) 1566 </div> 1567 1568 </em> 1569 </dt> 1570 <dd class="todo" style="display: none; "> 1571 Undocumented. 1572 </dd> 1573 <dd>The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'infobar', 'notification', 'popup'.</dd> 1574 <dd style="display: none; "> 1575 This parameter was added in version 1576 <b><span></span></b>. 1577 You must omit this parameter in earlier versions, 1578 and you may omit it in any version. If you require this 1579 parameter, the manifest key 1580 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1581 can ensure that your extension won't be run in an earlier browser version. 1582 </dd> 1583 1584 <!-- OBJECT PROPERTIES --> 1585 <dd style="display: none; "> 1586 <dl> 1587 <div> 1588 <div> 1589 </div> 1590 </div> 1591 </dl> 1592 </dd> 1593 1594 <!-- OBJECT METHODS --> 1595 <dd style="display: none; "> 1596 <div></div> 1597 </dd> 1598 1599 <!-- OBJECT EVENT FIELDS --> 1600 <dd style="display: none; "> 1601 <div></div> 1602 </dd> 1603 1604 <!-- FUNCTION PARAMETERS --> 1605 <dd style="display: none; "> 1606 <div></div> 1607 </dd> 1608 1609 </div> 1610 </div><div> 1611 <div> 1612 <dt> 1613 <var>windowId</var> 1614 <em> 1615 1616 <!-- TYPE --> 1617 <div style="display:inline"> 1618 ( 1619 <span class="optional">optional</span> 1620 <span class="enum" style="display: none; ">enumerated</span> 1621 <span id="typeTemplate"> 1622 <span style="display: none; "> 1623 <a> Type</a> 1624 </span> 1625 <span> 1626 <span style="display: none; "> 1627 array of <span><span></span></span> 1628 </span> 1629 <span>integer</span> 1630 <span style="display: none; "></span> 1631 </span> 1632 </span> 1633 ) 1634 </div> 1635 1636 </em> 1637 </dt> 1638 <dd class="todo" style="display: none; "> 1639 Undocumented. 1640 </dd> 1641 <dd>The window to restrict the search to. If omitted, returns all views.</dd> 1642 <dd style="display: none; "> 1643 This parameter was added in version 1644 <b><span></span></b>. 1645 You must omit this parameter in earlier versions, 1646 and you may omit it in any version. If you require this 1647 parameter, the manifest key 1648 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1649 can ensure that your extension won't be run in an earlier browser version. 1650 </dd> 1651 1652 <!-- OBJECT PROPERTIES --> 1653 <dd style="display: none; "> 1654 <dl> 1655 <div> 1656 <div> 1657 </div> 1658 </div> 1659 </dl> 1660 </dd> 1661 1662 <!-- OBJECT METHODS --> 1663 <dd style="display: none; "> 1664 <div></div> 1665 </dd> 1666 1667 <!-- OBJECT EVENT FIELDS --> 1668 <dd style="display: none; "> 1669 <div></div> 1670 </dd> 1671 1672 <!-- FUNCTION PARAMETERS --> 1673 <dd style="display: none; "> 1674 <div></div> 1675 </dd> 1676 1677 </div> 1678 </div> 1679 </dl> 1680 </dd> 1681 1682 <!-- OBJECT METHODS --> 1683 <dd style="display: none; "> 1684 <div></div> 1685 </dd> 1686 1687 <!-- OBJECT EVENT FIELDS --> 1688 <dd style="display: none; "> 1689 <div></div> 1690 </dd> 1691 1692 <!-- FUNCTION PARAMETERS --> 1693 <dd style="display: none; "> 1694 <div></div> 1695 </dd> 1696 1697 </div> 1698 </div> 1699 </dl> 1700 1701 <!-- RETURNS --> 1702 <h4>Returns</h4> 1703 <dl> 1704 <div> 1705 <div> 1706 <dt> 1707 <var style="display: none; ">paramName</var> 1708 <em> 1709 1710 <!-- TYPE --> 1711 <div style="display:inline"> 1712 ( 1713 <span class="optional" style="display: none; ">optional</span> 1714 <span class="enum" style="display: none; ">enumerated</span> 1715 <span id="typeTemplate"> 1716 <span style="display: none; "> 1717 <a> Type</a> 1718 </span> 1719 <span> 1720 <span> 1721 array of <span><span> 1722 <span style="display: none; "> 1723 <a> Type</a> 1724 </span> 1725 <span> 1726 <span style="display: none; "> 1727 array of <span><span></span></span> 1728 </span> 1729 <span>DOMWindow</span> 1730 <span style="display: none; "></span> 1731 </span> 1732 </span></span> 1733 </span> 1734 <span style="display: none; ">paramType</span> 1735 <span style="display: none; "></span> 1736 </span> 1737 </span> 1738 ) 1739 </div> 1740 1741 </em> 1742 </dt> 1743 <dd class="todo" style="display: none; "> 1744 Undocumented. 1745 </dd> 1746 <dd>Array of global objects</dd> 1747 <dd style="display: none; "> 1748 This parameter was added in version 1749 <b><span></span></b>. 1750 You must omit this parameter in earlier versions, 1751 and you may omit it in any version. If you require this 1752 parameter, the manifest key 1753 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1754 can ensure that your extension won't be run in an earlier browser version. 1755 </dd> 1756 1757 <!-- OBJECT PROPERTIES --> 1758 <dd style="display: none; "> 1759 <dl> 1760 <div> 1761 <div> 1762 </div> 1763 </div> 1764 </dl> 1765 </dd> 1766 1767 <!-- OBJECT METHODS --> 1768 <dd style="display: none; "> 1769 <div></div> 1770 </dd> 1771 1772 <!-- OBJECT EVENT FIELDS --> 1773 <dd style="display: none; "> 1774 <div></div> 1775 </dd> 1776 1777 <!-- FUNCTION PARAMETERS --> 1778 <dd style="display: none; "> 1779 <div></div> 1780 </dd> 1781 1782 </div> 1783 </div> 1784 </dl> 1785 1786 <!-- CALLBACK --> 1787 <div style="display: none; "> 1788 <div> 1789 <h4>Callback function</h4> 1790 <p> 1791 The callback <em>parameter</em> should specify a function 1792 that looks like this: 1793 </p> 1794 <p> 1795 If you specify the <em>callback</em> parameter, it should 1796 specify a function that looks like this: 1797 </p> 1798 1799 <!-- Note: intentionally longer 80 columns --> 1800 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1801 <dl> 1802 <div> 1803 <div> 1804 </div> 1805 </div> 1806 </dl> 1807 </div> 1808 </div> 1809 1810 <!-- MIN_VERSION --> 1811 <p style="display: none; "> 1812 This function was added in version <b><span></span></b>. 1813 If you require this function, the manifest key 1814 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1815 can ensure that your extension won't be run in an earlier browser version. 1816 </p> 1817 </div> <!-- /description --> 1818 1819 </div><div class="apiItem"> 1820 <a name="method-isAllowedFileSchemeAccess"></a> <!-- method-anchor --> 1821 <h4>isAllowedFileSchemeAccess</h4> 1822 1823 <div class="summary"><span style="display: none; ">void</span> 1824 <!-- Note: intentionally longer 80 columns --> 1825 <span>chrome.extension.isAllowedFileSchemeAccess</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> 1826 <var><span>callback</span></var></span>)</div> 1827 1828 <div class="description"> 1829 <p class="todo" style="display: none; ">Undocumented.</p> 1830 <p>Retrieves the state of the extension's access to the 'file://' scheme (as determined by the user-controlled 'Allow access to File URLs' checkbox.</p> 1831 1832 <!-- PARAMETERS --> 1833 <h4>Parameters</h4> 1834 <dl> 1835 <div> 1836 <div> 1837 <dt> 1838 <var>callback</var> 1839 <em> 1840 1841 <!-- TYPE --> 1842 <div style="display:inline"> 1843 ( 1844 <span class="optional" style="display: none; ">optional</span> 1845 <span class="enum" style="display: none; ">enumerated</span> 1846 <span id="typeTemplate"> 1847 <span style="display: none; "> 1848 <a> Type</a> 1849 </span> 1850 <span> 1851 <span style="display: none; "> 1852 array of <span><span></span></span> 1853 </span> 1854 <span>function</span> 1855 <span style="display: none; "></span> 1856 </span> 1857 </span> 1858 ) 1859 </div> 1860 1861 </em> 1862 </dt> 1863 <dd class="todo"> 1864 Undocumented. 1865 </dd> 1866 <dd style="display: none; "> 1867 Description of this parameter from the json schema. 1868 </dd> 1869 <dd style="display: none; "> 1870 This parameter was added in version 1871 <b><span></span></b>. 1872 You must omit this parameter in earlier versions, 1873 and you may omit it in any version. If you require this 1874 parameter, the manifest key 1875 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1876 can ensure that your extension won't be run in an earlier browser version. 1877 </dd> 1878 1879 <!-- OBJECT PROPERTIES --> 1880 <dd style="display: none; "> 1881 <dl> 1882 <div> 1883 <div> 1884 </div> 1885 </div> 1886 </dl> 1887 </dd> 1888 1889 <!-- OBJECT METHODS --> 1890 <dd style="display: none; "> 1891 <div></div> 1892 </dd> 1893 1894 <!-- OBJECT EVENT FIELDS --> 1895 <dd style="display: none; "> 1896 <div></div> 1897 </dd> 1898 1899 <!-- FUNCTION PARAMETERS --> 1900 <dd style="display: none; "> 1901 <div></div> 1902 </dd> 1903 1904 </div> 1905 </div> 1906 </dl> 1907 1908 <!-- RETURNS --> 1909 <h4 style="display: none; ">Returns</h4> 1910 <dl> 1911 <div style="display: none; "> 1912 <div> 1913 </div> 1914 </div> 1915 </dl> 1916 1917 <!-- CALLBACK --> 1918 <div> 1919 <div> 1920 <h4>Callback function</h4> 1921 <p> 1922 The callback <em>parameter</em> should specify a function 1923 that looks like this: 1924 </p> 1925 <p style="display: none; "> 1926 If you specify the <em>callback</em> parameter, it should 1927 specify a function that looks like this: 1928 </p> 1929 1930 <!-- Note: intentionally longer 80 columns --> 1931 <pre>function(<span>boolean isAllowedAccess</span>) <span class="subdued">{...}</span>;</pre> 1932 <dl> 1933 <div> 1934 <div> 1935 <dt> 1936 <var>isAllowedAccess</var> 1937 <em> 1938 1939 <!-- TYPE --> 1940 <div style="display:inline"> 1941 ( 1942 <span class="optional" style="display: none; ">optional</span> 1943 <span class="enum" style="display: none; ">enumerated</span> 1944 <span id="typeTemplate"> 1945 <span style="display: none; "> 1946 <a> Type</a> 1947 </span> 1948 <span> 1949 <span style="display: none; "> 1950 array of <span><span></span></span> 1951 </span> 1952 <span>boolean</span> 1953 <span style="display: none; "></span> 1954 </span> 1955 </span> 1956 ) 1957 </div> 1958 1959 </em> 1960 </dt> 1961 <dd class="todo" style="display: none; "> 1962 Undocumented. 1963 </dd> 1964 <dd>True if the extension can access the 'file://' scheme, false otherwise.</dd> 1965 <dd style="display: none; "> 1966 This parameter was added in version 1967 <b><span></span></b>. 1968 You must omit this parameter in earlier versions, 1969 and you may omit it in any version. If you require this 1970 parameter, the manifest key 1971 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1972 can ensure that your extension won't be run in an earlier browser version. 1973 </dd> 1974 1975 <!-- OBJECT PROPERTIES --> 1976 <dd style="display: none; "> 1977 <dl> 1978 <div> 1979 <div> 1980 </div> 1981 </div> 1982 </dl> 1983 </dd> 1984 1985 <!-- OBJECT METHODS --> 1986 <dd style="display: none; "> 1987 <div></div> 1988 </dd> 1989 1990 <!-- OBJECT EVENT FIELDS --> 1991 <dd style="display: none; "> 1992 <div></div> 1993 </dd> 1994 1995 <!-- FUNCTION PARAMETERS --> 1996 <dd style="display: none; "> 1997 <div></div> 1998 </dd> 1999 2000 </div> 2001 </div> 2002 </dl> 2003 </div> 2004 </div> 2005 2006 <!-- MIN_VERSION --> 2007 <p> 2008 This function was added in version <b><span>12.0.706.0</span></b>. 2009 If you require this function, the manifest key 2010 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2011 can ensure that your extension won't be run in an earlier browser version. 2012 </p> 2013 </div> <!-- /description --> 2014 2015 </div><div class="apiItem"> 2016 <a name="method-isAllowedIncognitoAccess"></a> <!-- method-anchor --> 2017 <h4>isAllowedIncognitoAccess</h4> 2018 2019 <div class="summary"><span style="display: none; ">void</span> 2020 <!-- Note: intentionally longer 80 columns --> 2021 <span>chrome.extension.isAllowedIncognitoAccess</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> 2022 <var><span>callback</span></var></span>)</div> 2023 2024 <div class="description"> 2025 <p class="todo" style="display: none; ">Undocumented.</p> 2026 <p>Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox.</p> 2027 2028 <!-- PARAMETERS --> 2029 <h4>Parameters</h4> 2030 <dl> 2031 <div> 2032 <div> 2033 <dt> 2034 <var>callback</var> 2035 <em> 2036 2037 <!-- TYPE --> 2038 <div style="display:inline"> 2039 ( 2040 <span class="optional" style="display: none; ">optional</span> 2041 <span class="enum" style="display: none; ">enumerated</span> 2042 <span id="typeTemplate"> 2043 <span style="display: none; "> 2044 <a> Type</a> 2045 </span> 2046 <span> 2047 <span style="display: none; "> 2048 array of <span><span></span></span> 2049 </span> 2050 <span>function</span> 2051 <span style="display: none; "></span> 2052 </span> 2053 </span> 2054 ) 2055 </div> 2056 2057 </em> 2058 </dt> 2059 <dd class="todo"> 2060 Undocumented. 2061 </dd> 2062 <dd style="display: none; "> 2063 Description of this parameter from the json schema. 2064 </dd> 2065 <dd style="display: none; "> 2066 This parameter was added in version 2067 <b><span></span></b>. 2068 You must omit this parameter in earlier versions, 2069 and you may omit it in any version. If you require this 2070 parameter, the manifest key 2071 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2072 can ensure that your extension won't be run in an earlier browser version. 2073 </dd> 2074 2075 <!-- OBJECT PROPERTIES --> 2076 <dd style="display: none; "> 2077 <dl> 2078 <div> 2079 <div> 2080 </div> 2081 </div> 2082 </dl> 2083 </dd> 2084 2085 <!-- OBJECT METHODS --> 2086 <dd style="display: none; "> 2087 <div></div> 2088 </dd> 2089 2090 <!-- OBJECT EVENT FIELDS --> 2091 <dd style="display: none; "> 2092 <div></div> 2093 </dd> 2094 2095 <!-- FUNCTION PARAMETERS --> 2096 <dd style="display: none; "> 2097 <div></div> 2098 </dd> 2099 2100 </div> 2101 </div> 2102 </dl> 2103 2104 <!-- RETURNS --> 2105 <h4 style="display: none; ">Returns</h4> 2106 <dl> 2107 <div style="display: none; "> 2108 <div> 2109 </div> 2110 </div> 2111 </dl> 2112 2113 <!-- CALLBACK --> 2114 <div> 2115 <div> 2116 <h4>Callback function</h4> 2117 <p> 2118 The callback <em>parameter</em> should specify a function 2119 that looks like this: 2120 </p> 2121 <p style="display: none; "> 2122 If you specify the <em>callback</em> parameter, it should 2123 specify a function that looks like this: 2124 </p> 2125 2126 <!-- Note: intentionally longer 80 columns --> 2127 <pre>function(<span>boolean isAllowedAccess</span>) <span class="subdued">{...}</span>;</pre> 2128 <dl> 2129 <div> 2130 <div> 2131 <dt> 2132 <var>isAllowedAccess</var> 2133 <em> 2134 2135 <!-- TYPE --> 2136 <div style="display:inline"> 2137 ( 2138 <span class="optional" style="display: none; ">optional</span> 2139 <span class="enum" style="display: none; ">enumerated</span> 2140 <span id="typeTemplate"> 2141 <span style="display: none; "> 2142 <a> Type</a> 2143 </span> 2144 <span> 2145 <span style="display: none; "> 2146 array of <span><span></span></span> 2147 </span> 2148 <span>boolean</span> 2149 <span style="display: none; "></span> 2150 </span> 2151 </span> 2152 ) 2153 </div> 2154 2155 </em> 2156 </dt> 2157 <dd class="todo" style="display: none; "> 2158 Undocumented. 2159 </dd> 2160 <dd>True if the extension has access to Incognito mode, false otherwise.</dd> 2161 <dd style="display: none; "> 2162 This parameter was added in version 2163 <b><span></span></b>. 2164 You must omit this parameter in earlier versions, 2165 and you may omit it in any version. If you require this 2166 parameter, the manifest key 2167 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2168 can ensure that your extension won't be run in an earlier browser version. 2169 </dd> 2170 2171 <!-- OBJECT PROPERTIES --> 2172 <dd style="display: none; "> 2173 <dl> 2174 <div> 2175 <div> 2176 </div> 2177 </div> 2178 </dl> 2179 </dd> 2180 2181 <!-- OBJECT METHODS --> 2182 <dd style="display: none; "> 2183 <div></div> 2184 </dd> 2185 2186 <!-- OBJECT EVENT FIELDS --> 2187 <dd style="display: none; "> 2188 <div></div> 2189 </dd> 2190 2191 <!-- FUNCTION PARAMETERS --> 2192 <dd style="display: none; "> 2193 <div></div> 2194 </dd> 2195 2196 </div> 2197 </div> 2198 </dl> 2199 </div> 2200 </div> 2201 2202 <!-- MIN_VERSION --> 2203 <p> 2204 This function was added in version <b><span>12.0.706.0</span></b>. 2205 If you require this function, the manifest key 2206 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2207 can ensure that your extension won't be run in an earlier browser version. 2208 </p> 2209 </div> <!-- /description --> 2210 2211 </div><div class="apiItem"> 2212 <a name="method-sendRequest"></a> <!-- method-anchor --> 2213 <h4>sendRequest</h4> 2214 2215 <div class="summary"><span style="display: none; ">void</span> 2216 <!-- Note: intentionally longer 80 columns --> 2217 <span>chrome.extension.sendRequest</span>(<span class="optional"><span style="display: none; ">, </span><span>string</span> 2218 <var><span>extensionId</span></var></span><span class="null"><span>, </span><span>any</span> 2219 <var><span>request</span></var></span><span class="optional"><span>, </span><span>function</span> 2220 <var><span>responseCallback</span></var></span>)</div> 2221 2222 <div class="description"> 2223 <p class="todo" style="display: none; ">Undocumented.</p> 2224 <p>Sends a single request to other listeners within the extension. Similar to chrome.extension.connect, but only sends a single request with an optional response. The <a href="extension.html#event-onRequest">chrome.extension.onRequest</a> event is fired in each page of the extension.</p> 2225 2226 <!-- PARAMETERS --> 2227 <h4>Parameters</h4> 2228 <dl> 2229 <div> 2230 <div> 2231 <dt> 2232 <var>extensionId</var> 2233 <em> 2234 2235 <!-- TYPE --> 2236 <div style="display:inline"> 2237 ( 2238 <span class="optional">optional</span> 2239 <span class="enum" style="display: none; ">enumerated</span> 2240 <span id="typeTemplate"> 2241 <span style="display: none; "> 2242 <a> Type</a> 2243 </span> 2244 <span> 2245 <span style="display: none; "> 2246 array of <span><span></span></span> 2247 </span> 2248 <span>string</span> 2249 <span style="display: none; "></span> 2250 </span> 2251 </span> 2252 ) 2253 </div> 2254 2255 </em> 2256 </dt> 2257 <dd class="todo" style="display: none; "> 2258 Undocumented. 2259 </dd> 2260 <dd>The extension ID of the extension you want to connect to. If omitted, default is your own extension.</dd> 2261 <dd style="display: none; "> 2262 This parameter was added in version 2263 <b><span></span></b>. 2264 You must omit this parameter in earlier versions, 2265 and you may omit it in any version. If you require this 2266 parameter, the manifest key 2267 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2268 can ensure that your extension won't be run in an earlier browser version. 2269 </dd> 2270 2271 <!-- OBJECT PROPERTIES --> 2272 <dd style="display: none; "> 2273 <dl> 2274 <div> 2275 <div> 2276 </div> 2277 </div> 2278 </dl> 2279 </dd> 2280 2281 <!-- OBJECT METHODS --> 2282 <dd style="display: none; "> 2283 <div></div> 2284 </dd> 2285 2286 <!-- OBJECT EVENT FIELDS --> 2287 <dd style="display: none; "> 2288 <div></div> 2289 </dd> 2290 2291 <!-- FUNCTION PARAMETERS --> 2292 <dd style="display: none; "> 2293 <div></div> 2294 </dd> 2295 2296 </div> 2297 </div><div> 2298 <div> 2299 <dt> 2300 <var>request</var> 2301 <em> 2302 2303 <!-- TYPE --> 2304 <div style="display:inline"> 2305 ( 2306 <span class="optional" style="display: none; ">optional</span> 2307 <span class="enum" style="display: none; ">enumerated</span> 2308 <span id="typeTemplate"> 2309 <span style="display: none; "> 2310 <a> Type</a> 2311 </span> 2312 <span> 2313 <span style="display: none; "> 2314 array of <span><span></span></span> 2315 </span> 2316 <span>any</span> 2317 <span style="display: none; "></span> 2318 </span> 2319 </span> 2320 ) 2321 </div> 2322 2323 </em> 2324 </dt> 2325 <dd class="todo"> 2326 Undocumented. 2327 </dd> 2328 <dd style="display: none; "> 2329 Description of this parameter from the json schema. 2330 </dd> 2331 <dd style="display: none; "> 2332 This parameter was added in version 2333 <b><span></span></b>. 2334 You must omit this parameter in earlier versions, 2335 and you may omit it in any version. If you require this 2336 parameter, the manifest key 2337 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2338 can ensure that your extension won't be run in an earlier browser version. 2339 </dd> 2340 2341 <!-- OBJECT PROPERTIES --> 2342 <dd style="display: none; "> 2343 <dl> 2344 <div> 2345 <div> 2346 </div> 2347 </div> 2348 </dl> 2349 </dd> 2350 2351 <!-- OBJECT METHODS --> 2352 <dd style="display: none; "> 2353 <div></div> 2354 </dd> 2355 2356 <!-- OBJECT EVENT FIELDS --> 2357 <dd style="display: none; "> 2358 <div></div> 2359 </dd> 2360 2361 <!-- FUNCTION PARAMETERS --> 2362 <dd style="display: none; "> 2363 <div></div> 2364 </dd> 2365 2366 </div> 2367 </div><div> 2368 <div> 2369 <dt> 2370 <var>responseCallback</var> 2371 <em> 2372 2373 <!-- TYPE --> 2374 <div style="display:inline"> 2375 ( 2376 <span class="optional">optional</span> 2377 <span class="enum" style="display: none; ">enumerated</span> 2378 <span id="typeTemplate"> 2379 <span style="display: none; "> 2380 <a> Type</a> 2381 </span> 2382 <span> 2383 <span style="display: none; "> 2384 array of <span><span></span></span> 2385 </span> 2386 <span>function</span> 2387 <span style="display: none; "></span> 2388 </span> 2389 </span> 2390 ) 2391 </div> 2392 2393 </em> 2394 </dt> 2395 <dd class="todo"> 2396 Undocumented. 2397 </dd> 2398 <dd style="display: none; "> 2399 Description of this parameter from the json schema. 2400 </dd> 2401 <dd style="display: none; "> 2402 This parameter was added in version 2403 <b><span></span></b>. 2404 You must omit this parameter in earlier versions, 2405 and you may omit it in any version. If you require this 2406 parameter, the manifest key 2407 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2408 can ensure that your extension won't be run in an earlier browser version. 2409 </dd> 2410 2411 <!-- OBJECT PROPERTIES --> 2412 <dd style="display: none; "> 2413 <dl> 2414 <div> 2415 <div> 2416 </div> 2417 </div> 2418 </dl> 2419 </dd> 2420 2421 <!-- OBJECT METHODS --> 2422 <dd style="display: none; "> 2423 <div></div> 2424 </dd> 2425 2426 <!-- OBJECT EVENT FIELDS --> 2427 <dd style="display: none; "> 2428 <div></div> 2429 </dd> 2430 2431 <!-- FUNCTION PARAMETERS --> 2432 <dd> 2433 <div> 2434 <h5>Parameters</h5> 2435 <dl> 2436 <div> 2437 <div> 2438 <dt> 2439 <var>response</var> 2440 <em> 2441 2442 <!-- TYPE --> 2443 <div style="display:inline"> 2444 ( 2445 <span class="optional" style="display: none; ">optional</span> 2446 <span class="enum" style="display: none; ">enumerated</span> 2447 <span id="typeTemplate"> 2448 <span style="display: none; "> 2449 <a> Type</a> 2450 </span> 2451 <span> 2452 <span style="display: none; "> 2453 array of <span><span></span></span> 2454 </span> 2455 <span>any</span> 2456 <span style="display: none; "></span> 2457 </span> 2458 </span> 2459 ) 2460 </div> 2461 2462 </em> 2463 </dt> 2464 <dd class="todo" style="display: none; "> 2465 Undocumented. 2466 </dd> 2467 <dd>The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set to the error message.</dd> 2468 <dd style="display: none; "> 2469 This parameter was added in version 2470 <b><span></span></b>. 2471 You must omit this parameter in earlier versions, 2472 and you may omit it in any version. If you require this 2473 parameter, the manifest key 2474 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2475 can ensure that your extension won't be run in an earlier browser version. 2476 </dd> 2477 2478 <!-- OBJECT PROPERTIES --> 2479 <dd style="display: none; "> 2480 <dl> 2481 <div> 2482 <div> 2483 </div> 2484 </div> 2485 </dl> 2486 </dd> 2487 2488 <!-- OBJECT METHODS --> 2489 <dd style="display: none; "> 2490 <div></div> 2491 </dd> 2492 2493 <!-- OBJECT EVENT FIELDS --> 2494 <dd style="display: none; "> 2495 <div></div> 2496 </dd> 2497 2498 <!-- FUNCTION PARAMETERS --> 2499 <dd style="display: none; "> 2500 <div></div> 2501 </dd> 2502 2503 </div> 2504 </div> 2505 </dl> 2506 </div> 2507 </dd> 2508 2509 </div> 2510 </div> 2511 </dl> 2512 2513 <!-- RETURNS --> 2514 <h4 style="display: none; ">Returns</h4> 2515 <dl> 2516 <div style="display: none; "> 2517 <div> 2518 </div> 2519 </div> 2520 </dl> 2521 2522 <!-- CALLBACK --> 2523 <div> 2524 <div> 2525 <h4>Callback function</h4> 2526 <p style="display: none; "> 2527 The callback <em>parameter</em> should specify a function 2528 that looks like this: 2529 </p> 2530 <p> 2531 If you specify the <em>callback</em> parameter, it should 2532 specify a function that looks like this: 2533 </p> 2534 2535 <!-- Note: intentionally longer 80 columns --> 2536 <pre>function(<span>any response</span>) <span class="subdued">{...}</span>;</pre> 2537 <dl> 2538 <div> 2539 <div> 2540 <dt> 2541 <var>response</var> 2542 <em> 2543 2544 <!-- TYPE --> 2545 <div style="display:inline"> 2546 ( 2547 <span class="optional" style="display: none; ">optional</span> 2548 <span class="enum" style="display: none; ">enumerated</span> 2549 <span id="typeTemplate"> 2550 <span style="display: none; "> 2551 <a> Type</a> 2552 </span> 2553 <span> 2554 <span style="display: none; "> 2555 array of <span><span></span></span> 2556 </span> 2557 <span>any</span> 2558 <span style="display: none; "></span> 2559 </span> 2560 </span> 2561 ) 2562 </div> 2563 2564 </em> 2565 </dt> 2566 <dd class="todo" style="display: none; "> 2567 Undocumented. 2568 </dd> 2569 <dd>The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set to the error message.</dd> 2570 <dd style="display: none; "> 2571 This parameter was added in version 2572 <b><span></span></b>. 2573 You must omit this parameter in earlier versions, 2574 and you may omit it in any version. If you require this 2575 parameter, the manifest key 2576 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2577 can ensure that your extension won't be run in an earlier browser version. 2578 </dd> 2579 2580 <!-- OBJECT PROPERTIES --> 2581 <dd style="display: none; "> 2582 <dl> 2583 <div> 2584 <div> 2585 </div> 2586 </div> 2587 </dl> 2588 </dd> 2589 2590 <!-- OBJECT METHODS --> 2591 <dd style="display: none; "> 2592 <div></div> 2593 </dd> 2594 2595 <!-- OBJECT EVENT FIELDS --> 2596 <dd style="display: none; "> 2597 <div></div> 2598 </dd> 2599 2600 <!-- FUNCTION PARAMETERS --> 2601 <dd style="display: none; "> 2602 <div></div> 2603 </dd> 2604 2605 </div> 2606 </div> 2607 </dl> 2608 </div> 2609 </div> 2610 2611 <!-- MIN_VERSION --> 2612 <p style="display: none; "> 2613 This function was added in version <b><span></span></b>. 2614 If you require this function, the manifest key 2615 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2616 can ensure that your extension won't be run in an earlier browser version. 2617 </p> 2618 </div> <!-- /description --> 2619 2620 </div><div class="apiItem"> 2621 <a name="method-setUpdateUrlData"></a> <!-- method-anchor --> 2622 <h4>setUpdateUrlData</h4> 2623 2624 <div class="summary"><span style="display: none; ">void</span> 2625 <!-- Note: intentionally longer 80 columns --> 2626 <span>chrome.extension.setUpdateUrlData</span>(<span class="null"><span style="display: none; ">, </span><span>string</span> 2627 <var><span>data</span></var></span>)</div> 2628 2629 <div class="description"> 2630 <p class="todo" style="display: none; ">Undocumented.</p> 2631 <p>Sets the value of the ap CGI parameter used in the extension's update URL. This value is ignored for extensions that are hosted in the Chrome Extension Gallery.</p> 2632 2633 <!-- PARAMETERS --> 2634 <h4>Parameters</h4> 2635 <dl> 2636 <div> 2637 <div> 2638 <dt> 2639 <var>data</var> 2640 <em> 2641 2642 <!-- TYPE --> 2643 <div style="display:inline"> 2644 ( 2645 <span class="optional" style="display: none; ">optional</span> 2646 <span class="enum" style="display: none; ">enumerated</span> 2647 <span id="typeTemplate"> 2648 <span style="display: none; "> 2649 <a> Type</a> 2650 </span> 2651 <span> 2652 <span style="display: none; "> 2653 array of <span><span></span></span> 2654 </span> 2655 <span>string</span> 2656 <span style="display: none; "></span> 2657 </span> 2658 </span> 2659 ) 2660 </div> 2661 2662 </em> 2663 </dt> 2664 <dd class="todo"> 2665 Undocumented. 2666 </dd> 2667 <dd style="display: none; "> 2668 Description of this parameter from the json schema. 2669 </dd> 2670 <dd style="display: none; "> 2671 This parameter was added in version 2672 <b><span></span></b>. 2673 You must omit this parameter in earlier versions, 2674 and you may omit it in any version. If you require this 2675 parameter, the manifest key 2676 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2677 can ensure that your extension won't be run in an earlier browser version. 2678 </dd> 2679 2680 <!-- OBJECT PROPERTIES --> 2681 <dd style="display: none; "> 2682 <dl> 2683 <div> 2684 <div> 2685 </div> 2686 </div> 2687 </dl> 2688 </dd> 2689 2690 <!-- OBJECT METHODS --> 2691 <dd style="display: none; "> 2692 <div></div> 2693 </dd> 2694 2695 <!-- OBJECT EVENT FIELDS --> 2696 <dd style="display: none; "> 2697 <div></div> 2698 </dd> 2699 2700 <!-- FUNCTION PARAMETERS --> 2701 <dd style="display: none; "> 2702 <div></div> 2703 </dd> 2704 2705 </div> 2706 </div> 2707 </dl> 2708 2709 <!-- RETURNS --> 2710 <h4 style="display: none; ">Returns</h4> 2711 <dl> 2712 <div style="display: none; "> 2713 <div> 2714 </div> 2715 </div> 2716 </dl> 2717 2718 <!-- CALLBACK --> 2719 <div style="display: none; "> 2720 <div> 2721 <h4>Callback function</h4> 2722 <p> 2723 The callback <em>parameter</em> should specify a function 2724 that looks like this: 2725 </p> 2726 <p> 2727 If you specify the <em>callback</em> parameter, it should 2728 specify a function that looks like this: 2729 </p> 2730 2731 <!-- Note: intentionally longer 80 columns --> 2732 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 2733 <dl> 2734 <div> 2735 <div> 2736 </div> 2737 </div> 2738 </dl> 2739 </div> 2740 </div> 2741 2742 <!-- MIN_VERSION --> 2743 <p style="display: none; "> 2744 This function was added in version <b><span></span></b>. 2745 If you require this function, the manifest key 2746 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2747 can ensure that your extension won't be run in an earlier browser version. 2748 </p> 2749 </div> <!-- /description --> 2750 2751 </div> <!-- /apiItem --> 2752 2753 </div> <!-- /apiGroup --> 2754 2755 <!-- EVENTS --> 2756 <div id="eventsTemplate" class="apiGroup"> 2757 <a name="global-events"></a> 2758 <h3>Events</h3> 2759 <!-- iterates over all events --> 2760 <div class="apiItem"> 2761 <a name="event-onConnect"></a> 2762 <h4>onConnect</h4> 2763 2764 <div class="summary"> 2765 <!-- Note: intentionally longer 80 columns --> 2766 <span class="subdued">chrome.extension.</span><span>onConnect</span><span class="subdued">.addListener</span>(function(<span>Port port</span>) <span class="subdued">{...}</span>); 2767 </div> 2768 2769 <div class="description"> 2770 <p class="todo" style="display: none; ">Undocumented.</p> 2771 <p>Fired when a connection is made from either an extension process or a content script.</p> 2772 2773 <!-- PARAMETERS --> 2774 <div> 2775 <h4>Parameters</h4> 2776 <dl> 2777 <div> 2778 <div> 2779 <dt> 2780 <var>port</var> 2781 <em> 2782 2783 <!-- TYPE --> 2784 <div style="display:inline"> 2785 ( 2786 <span class="optional" style="display: none; ">optional</span> 2787 <span class="enum" style="display: none; ">enumerated</span> 2788 <span id="typeTemplate"> 2789 <span> 2790 <a href="extension.html#type-Port">Port</a> 2791 </span> 2792 <span style="display: none; "> 2793 <span> 2794 array of <span><span></span></span> 2795 </span> 2796 <span>paramType</span> 2797 <span></span> 2798 </span> 2799 </span> 2800 ) 2801 </div> 2802 2803 </em> 2804 </dt> 2805 <dd class="todo"> 2806 Undocumented. 2807 </dd> 2808 <dd style="display: none; "> 2809 Description of this parameter from the json schema. 2810 </dd> 2811 <dd style="display: none; "> 2812 This parameter was added in version 2813 <b><span></span></b>. 2814 You must omit this parameter in earlier versions, 2815 and you may omit it in any version. If you require this 2816 parameter, the manifest key 2817 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2818 can ensure that your extension won't be run in an earlier browser version. 2819 </dd> 2820 2821 <!-- OBJECT PROPERTIES --> 2822 <dd style="display: none; "> 2823 <dl> 2824 <div> 2825 <div> 2826 </div> 2827 </div> 2828 </dl> 2829 </dd> 2830 2831 <!-- OBJECT METHODS --> 2832 <dd style="display: none; "> 2833 <div></div> 2834 </dd> 2835 2836 <!-- OBJECT EVENT FIELDS --> 2837 <dd style="display: none; "> 2838 <div></div> 2839 </dd> 2840 2841 <!-- FUNCTION PARAMETERS --> 2842 <dd style="display: none; "> 2843 <div></div> 2844 </dd> 2845 2846 </div> 2847 </div> 2848 </dl> 2849 </div> 2850 </div> <!-- /decription --> 2851 2852 </div><div class="apiItem"> 2853 <a name="event-onConnectExternal"></a> 2854 <h4>onConnectExternal</h4> 2855 2856 <div class="summary"> 2857 <!-- Note: intentionally longer 80 columns --> 2858 <span class="subdued">chrome.extension.</span><span>onConnectExternal</span><span class="subdued">.addListener</span>(function(<span>Port port</span>) <span class="subdued">{...}</span>); 2859 </div> 2860 2861 <div class="description"> 2862 <p class="todo" style="display: none; ">Undocumented.</p> 2863 <p>Fired when a connection is made from another extension.</p> 2864 2865 <!-- PARAMETERS --> 2866 <div> 2867 <h4>Parameters</h4> 2868 <dl> 2869 <div> 2870 <div> 2871 <dt> 2872 <var>port</var> 2873 <em> 2874 2875 <!-- TYPE --> 2876 <div style="display:inline"> 2877 ( 2878 <span class="optional" style="display: none; ">optional</span> 2879 <span class="enum" style="display: none; ">enumerated</span> 2880 <span id="typeTemplate"> 2881 <span> 2882 <a href="extension.html#type-Port">Port</a> 2883 </span> 2884 <span style="display: none; "> 2885 <span> 2886 array of <span><span></span></span> 2887 </span> 2888 <span>paramType</span> 2889 <span></span> 2890 </span> 2891 </span> 2892 ) 2893 </div> 2894 2895 </em> 2896 </dt> 2897 <dd class="todo"> 2898 Undocumented. 2899 </dd> 2900 <dd style="display: none; "> 2901 Description of this parameter from the json schema. 2902 </dd> 2903 <dd style="display: none; "> 2904 This parameter was added in version 2905 <b><span></span></b>. 2906 You must omit this parameter in earlier versions, 2907 and you may omit it in any version. If you require this 2908 parameter, the manifest key 2909 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2910 can ensure that your extension won't be run in an earlier browser version. 2911 </dd> 2912 2913 <!-- OBJECT PROPERTIES --> 2914 <dd style="display: none; "> 2915 <dl> 2916 <div> 2917 <div> 2918 </div> 2919 </div> 2920 </dl> 2921 </dd> 2922 2923 <!-- OBJECT METHODS --> 2924 <dd style="display: none; "> 2925 <div></div> 2926 </dd> 2927 2928 <!-- OBJECT EVENT FIELDS --> 2929 <dd style="display: none; "> 2930 <div></div> 2931 </dd> 2932 2933 <!-- FUNCTION PARAMETERS --> 2934 <dd style="display: none; "> 2935 <div></div> 2936 </dd> 2937 2938 </div> 2939 </div> 2940 </dl> 2941 </div> 2942 </div> <!-- /decription --> 2943 2944 </div><div class="apiItem"> 2945 <a name="event-onRequest"></a> 2946 <h4>onRequest</h4> 2947 2948 <div class="summary"> 2949 <!-- Note: intentionally longer 80 columns --> 2950 <span class="subdued">chrome.extension.</span><span>onRequest</span><span class="subdued">.addListener</span>(function(<span>any request, MessageSender sender, function sendResponse</span>) <span class="subdued">{...}</span>); 2951 </div> 2952 2953 <div class="description"> 2954 <p class="todo" style="display: none; ">Undocumented.</p> 2955 <p>Fired when a request is sent from either an extension process or a content script.</p> 2956 2957 <!-- PARAMETERS --> 2958 <div> 2959 <h4>Parameters</h4> 2960 <dl> 2961 <div> 2962 <div> 2963 <dt> 2964 <var>request</var> 2965 <em> 2966 2967 <!-- TYPE --> 2968 <div style="display:inline"> 2969 ( 2970 <span class="optional" style="display: none; ">optional</span> 2971 <span class="enum" style="display: none; ">enumerated</span> 2972 <span id="typeTemplate"> 2973 <span style="display: none; "> 2974 <a> Type</a> 2975 </span> 2976 <span> 2977 <span style="display: none; "> 2978 array of <span><span></span></span> 2979 </span> 2980 <span>any</span> 2981 <span style="display: none; "></span> 2982 </span> 2983 </span> 2984 ) 2985 </div> 2986 2987 </em> 2988 </dt> 2989 <dd class="todo" style="display: none; "> 2990 Undocumented. 2991 </dd> 2992 <dd>The request sent by the calling script.</dd> 2993 <dd style="display: none; "> 2994 This parameter was added in version 2995 <b><span></span></b>. 2996 You must omit this parameter in earlier versions, 2997 and you may omit it in any version. If you require this 2998 parameter, the manifest key 2999 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3000 can ensure that your extension won't be run in an earlier browser version. 3001 </dd> 3002 3003 <!-- OBJECT PROPERTIES --> 3004 <dd style="display: none; "> 3005 <dl> 3006 <div> 3007 <div> 3008 </div> 3009 </div> 3010 </dl> 3011 </dd> 3012 3013 <!-- OBJECT METHODS --> 3014 <dd style="display: none; "> 3015 <div></div> 3016 </dd> 3017 3018 <!-- OBJECT EVENT FIELDS --> 3019 <dd style="display: none; "> 3020 <div></div> 3021 </dd> 3022 3023 <!-- FUNCTION PARAMETERS --> 3024 <dd style="display: none; "> 3025 <div></div> 3026 </dd> 3027 3028 </div> 3029 </div><div> 3030 <div> 3031 <dt> 3032 <var>sender</var> 3033 <em> 3034 3035 <!-- TYPE --> 3036 <div style="display:inline"> 3037 ( 3038 <span class="optional" style="display: none; ">optional</span> 3039 <span class="enum" style="display: none; ">enumerated</span> 3040 <span id="typeTemplate"> 3041 <span> 3042 <a href="extension.html#type-MessageSender">MessageSender</a> 3043 </span> 3044 <span style="display: none; "> 3045 <span> 3046 array of <span><span></span></span> 3047 </span> 3048 <span>paramType</span> 3049 <span></span> 3050 </span> 3051 </span> 3052 ) 3053 </div> 3054 3055 </em> 3056 </dt> 3057 <dd class="todo"> 3058 Undocumented. 3059 </dd> 3060 <dd style="display: none; "> 3061 Description of this parameter from the json schema. 3062 </dd> 3063 <dd style="display: none; "> 3064 This parameter was added in version 3065 <b><span></span></b>. 3066 You must omit this parameter in earlier versions, 3067 and you may omit it in any version. If you require this 3068 parameter, the manifest key 3069 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3070 can ensure that your extension won't be run in an earlier browser version. 3071 </dd> 3072 3073 <!-- OBJECT PROPERTIES --> 3074 <dd style="display: none; "> 3075 <dl> 3076 <div> 3077 <div> 3078 </div> 3079 </div> 3080 </dl> 3081 </dd> 3082 3083 <!-- OBJECT METHODS --> 3084 <dd style="display: none; "> 3085 <div></div> 3086 </dd> 3087 3088 <!-- OBJECT EVENT FIELDS --> 3089 <dd style="display: none; "> 3090 <div></div> 3091 </dd> 3092 3093 <!-- FUNCTION PARAMETERS --> 3094 <dd style="display: none; "> 3095 <div></div> 3096 </dd> 3097 3098 </div> 3099 </div><div> 3100 <div> 3101 <dt> 3102 <var>sendResponse</var> 3103 <em> 3104 3105 <!-- TYPE --> 3106 <div style="display:inline"> 3107 ( 3108 <span class="optional" style="display: none; ">optional</span> 3109 <span class="enum" style="display: none; ">enumerated</span> 3110 <span id="typeTemplate"> 3111 <span style="display: none; "> 3112 <a> Type</a> 3113 </span> 3114 <span> 3115 <span style="display: none; "> 3116 array of <span><span></span></span> 3117 </span> 3118 <span>function</span> 3119 <span style="display: none; "></span> 3120 </span> 3121 </span> 3122 ) 3123 </div> 3124 3125 </em> 3126 </dt> 3127 <dd class="todo" style="display: none; "> 3128 Undocumented. 3129 </dd> 3130 <dd>Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response.</dd> 3131 <dd style="display: none; "> 3132 This parameter was added in version 3133 <b><span></span></b>. 3134 You must omit this parameter in earlier versions, 3135 and you may omit it in any version. If you require this 3136 parameter, the manifest key 3137 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3138 can ensure that your extension won't be run in an earlier browser version. 3139 </dd> 3140 3141 <!-- OBJECT PROPERTIES --> 3142 <dd style="display: none; "> 3143 <dl> 3144 <div> 3145 <div> 3146 </div> 3147 </div> 3148 </dl> 3149 </dd> 3150 3151 <!-- OBJECT METHODS --> 3152 <dd style="display: none; "> 3153 <div></div> 3154 </dd> 3155 3156 <!-- OBJECT EVENT FIELDS --> 3157 <dd style="display: none; "> 3158 <div></div> 3159 </dd> 3160 3161 <!-- FUNCTION PARAMETERS --> 3162 <dd style="display: none; "> 3163 <div></div> 3164 </dd> 3165 3166 </div> 3167 </div> 3168 </dl> 3169 </div> 3170 </div> <!-- /decription --> 3171 3172 </div><div class="apiItem"> 3173 <a name="event-onRequestExternal"></a> 3174 <h4>onRequestExternal</h4> 3175 3176 <div class="summary"> 3177 <!-- Note: intentionally longer 80 columns --> 3178 <span class="subdued">chrome.extension.</span><span>onRequestExternal</span><span class="subdued">.addListener</span>(function(<span>any request, MessageSender sender, function sendResponse</span>) <span class="subdued">{...}</span>); 3179 </div> 3180 3181 <div class="description"> 3182 <p class="todo" style="display: none; ">Undocumented.</p> 3183 <p>Fired when a request is sent from another extension.</p> 3184 3185 <!-- PARAMETERS --> 3186 <div> 3187 <h4>Parameters</h4> 3188 <dl> 3189 <div> 3190 <div> 3191 <dt> 3192 <var>request</var> 3193 <em> 3194 3195 <!-- TYPE --> 3196 <div style="display:inline"> 3197 ( 3198 <span class="optional" style="display: none; ">optional</span> 3199 <span class="enum" style="display: none; ">enumerated</span> 3200 <span id="typeTemplate"> 3201 <span style="display: none; "> 3202 <a> Type</a> 3203 </span> 3204 <span> 3205 <span style="display: none; "> 3206 array of <span><span></span></span> 3207 </span> 3208 <span>any</span> 3209 <span style="display: none; "></span> 3210 </span> 3211 </span> 3212 ) 3213 </div> 3214 3215 </em> 3216 </dt> 3217 <dd class="todo" style="display: none; "> 3218 Undocumented. 3219 </dd> 3220 <dd>The request sent by the calling script.</dd> 3221 <dd style="display: none; "> 3222 This parameter was added in version 3223 <b><span></span></b>. 3224 You must omit this parameter in earlier versions, 3225 and you may omit it in any version. If you require this 3226 parameter, the manifest key 3227 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3228 can ensure that your extension won't be run in an earlier browser version. 3229 </dd> 3230 3231 <!-- OBJECT PROPERTIES --> 3232 <dd style="display: none; "> 3233 <dl> 3234 <div> 3235 <div> 3236 </div> 3237 </div> 3238 </dl> 3239 </dd> 3240 3241 <!-- OBJECT METHODS --> 3242 <dd style="display: none; "> 3243 <div></div> 3244 </dd> 3245 3246 <!-- OBJECT EVENT FIELDS --> 3247 <dd style="display: none; "> 3248 <div></div> 3249 </dd> 3250 3251 <!-- FUNCTION PARAMETERS --> 3252 <dd style="display: none; "> 3253 <div></div> 3254 </dd> 3255 3256 </div> 3257 </div><div> 3258 <div> 3259 <dt> 3260 <var>sender</var> 3261 <em> 3262 3263 <!-- TYPE --> 3264 <div style="display:inline"> 3265 ( 3266 <span class="optional" style="display: none; ">optional</span> 3267 <span class="enum" style="display: none; ">enumerated</span> 3268 <span id="typeTemplate"> 3269 <span> 3270 <a href="extension.html#type-MessageSender">MessageSender</a> 3271 </span> 3272 <span style="display: none; "> 3273 <span> 3274 array of <span><span></span></span> 3275 </span> 3276 <span>paramType</span> 3277 <span></span> 3278 </span> 3279 </span> 3280 ) 3281 </div> 3282 3283 </em> 3284 </dt> 3285 <dd class="todo"> 3286 Undocumented. 3287 </dd> 3288 <dd style="display: none; "> 3289 Description of this parameter from the json schema. 3290 </dd> 3291 <dd style="display: none; "> 3292 This parameter was added in version 3293 <b><span></span></b>. 3294 You must omit this parameter in earlier versions, 3295 and you may omit it in any version. If you require this 3296 parameter, the manifest key 3297 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3298 can ensure that your extension won't be run in an earlier browser version. 3299 </dd> 3300 3301 <!-- OBJECT PROPERTIES --> 3302 <dd style="display: none; "> 3303 <dl> 3304 <div> 3305 <div> 3306 </div> 3307 </div> 3308 </dl> 3309 </dd> 3310 3311 <!-- OBJECT METHODS --> 3312 <dd style="display: none; "> 3313 <div></div> 3314 </dd> 3315 3316 <!-- OBJECT EVENT FIELDS --> 3317 <dd style="display: none; "> 3318 <div></div> 3319 </dd> 3320 3321 <!-- FUNCTION PARAMETERS --> 3322 <dd style="display: none; "> 3323 <div></div> 3324 </dd> 3325 3326 </div> 3327 </div><div> 3328 <div> 3329 <dt> 3330 <var>sendResponse</var> 3331 <em> 3332 3333 <!-- TYPE --> 3334 <div style="display:inline"> 3335 ( 3336 <span class="optional" style="display: none; ">optional</span> 3337 <span class="enum" style="display: none; ">enumerated</span> 3338 <span id="typeTemplate"> 3339 <span style="display: none; "> 3340 <a> Type</a> 3341 </span> 3342 <span> 3343 <span style="display: none; "> 3344 array of <span><span></span></span> 3345 </span> 3346 <span>function</span> 3347 <span style="display: none; "></span> 3348 </span> 3349 </span> 3350 ) 3351 </div> 3352 3353 </em> 3354 </dt> 3355 <dd class="todo" style="display: none; "> 3356 Undocumented. 3357 </dd> 3358 <dd>Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response.</dd> 3359 <dd style="display: none; "> 3360 This parameter was added in version 3361 <b><span></span></b>. 3362 You must omit this parameter in earlier versions, 3363 and you may omit it in any version. If you require this 3364 parameter, the manifest key 3365 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3366 can ensure that your extension won't be run in an earlier browser version. 3367 </dd> 3368 3369 <!-- OBJECT PROPERTIES --> 3370 <dd style="display: none; "> 3371 <dl> 3372 <div> 3373 <div> 3374 </div> 3375 </div> 3376 </dl> 3377 </dd> 3378 3379 <!-- OBJECT METHODS --> 3380 <dd style="display: none; "> 3381 <div></div> 3382 </dd> 3383 3384 <!-- OBJECT EVENT FIELDS --> 3385 <dd style="display: none; "> 3386 <div></div> 3387 </dd> 3388 3389 <!-- FUNCTION PARAMETERS --> 3390 <dd style="display: none; "> 3391 <div></div> 3392 </dd> 3393 3394 </div> 3395 </div> 3396 </dl> 3397 </div> 3398 </div> <!-- /decription --> 3399 3400 </div> <!-- /apiItem --> 3401 3402 </div> <!-- /apiGroup --> 3403 3404 <!-- TYPES --> 3405 <div class="apiGroup"> 3406 <a name="types"></a> 3407 <h3 id="types">Types</h3> 3408 3409 <!-- iterates over all types --> 3410 <div class="apiItem"> 3411 <a name="type-MessageSender"></a> 3412 <h4>MessageSender</h4> 3413 3414 <div> 3415 <dt> 3416 <var style="display: none; ">paramName</var> 3417 <em> 3418 3419 <!-- TYPE --> 3420 <div style="display:inline"> 3421 ( 3422 <span class="optional" style="display: none; ">optional</span> 3423 <span class="enum" style="display: none; ">enumerated</span> 3424 <span id="typeTemplate"> 3425 <span style="display: none; "> 3426 <a> Type</a> 3427 </span> 3428 <span> 3429 <span style="display: none; "> 3430 array of <span><span></span></span> 3431 </span> 3432 <span>object</span> 3433 <span style="display: none; "></span> 3434 </span> 3435 </span> 3436 ) 3437 </div> 3438 3439 </em> 3440 </dt> 3441 <dd class="todo" style="display: none; "> 3442 Undocumented. 3443 </dd> 3444 <dd>An object containing information about the script context that sent a message or request.</dd> 3445 <dd style="display: none; "> 3446 This parameter was added in version 3447 <b><span></span></b>. 3448 You must omit this parameter in earlier versions, 3449 and you may omit it in any version. If you require this 3450 parameter, the manifest key 3451 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3452 can ensure that your extension won't be run in an earlier browser version. 3453 </dd> 3454 3455 <!-- OBJECT PROPERTIES --> 3456 <dd> 3457 <dl> 3458 <div> 3459 <div> 3460 <dt> 3461 <var>tab</var> 3462 <em> 3463 3464 <!-- TYPE --> 3465 <div style="display:inline"> 3466 ( 3467 <span class="optional">optional</span> 3468 <span class="enum" style="display: none; ">enumerated</span> 3469 <span id="typeTemplate"> 3470 <span> 3471 <a href="tabs.html#type-Tab">Tab</a> 3472 </span> 3473 <span style="display: none; "> 3474 <span> 3475 array of <span><span></span></span> 3476 </span> 3477 <span>paramType</span> 3478 <span></span> 3479 </span> 3480 </span> 3481 ) 3482 </div> 3483 3484 </em> 3485 </dt> 3486 <dd class="todo" style="display: none; "> 3487 Undocumented. 3488 </dd> 3489 <dd>This property will <b>only</b> be present when the connection was opened from a tab or content script.</dd> 3490 <dd style="display: none; "> 3491 This parameter was added in version 3492 <b><span></span></b>. 3493 You must omit this parameter in earlier versions, 3494 and you may omit it in any version. If you require this 3495 parameter, the manifest key 3496 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3497 can ensure that your extension won't be run in an earlier browser version. 3498 </dd> 3499 3500 <!-- OBJECT PROPERTIES --> 3501 <dd style="display: none; "> 3502 <dl> 3503 <div> 3504 <div> 3505 </div> 3506 </div> 3507 </dl> 3508 </dd> 3509 3510 <!-- OBJECT METHODS --> 3511 <dd style="display: none; "> 3512 <div></div> 3513 </dd> 3514 3515 <!-- OBJECT EVENT FIELDS --> 3516 <dd style="display: none; "> 3517 <div></div> 3518 </dd> 3519 3520 <!-- FUNCTION PARAMETERS --> 3521 <dd style="display: none; "> 3522 <div></div> 3523 </dd> 3524 3525 </div> 3526 </div><div> 3527 <div> 3528 <dt> 3529 <var>id</var> 3530 <em> 3531 3532 <!-- TYPE --> 3533 <div style="display:inline"> 3534 ( 3535 <span class="optional" style="display: none; ">optional</span> 3536 <span class="enum" style="display: none; ">enumerated</span> 3537 <span id="typeTemplate"> 3538 <span style="display: none; "> 3539 <a> Type</a> 3540 </span> 3541 <span> 3542 <span style="display: none; "> 3543 array of <span><span></span></span> 3544 </span> 3545 <span>string</span> 3546 <span style="display: none; "></span> 3547 </span> 3548 </span> 3549 ) 3550 </div> 3551 3552 </em> 3553 </dt> 3554 <dd class="todo" style="display: none; "> 3555 Undocumented. 3556 </dd> 3557 <dd>The extension ID of the extension that opened the connection.</dd> 3558 <dd style="display: none; "> 3559 This parameter was added in version 3560 <b><span></span></b>. 3561 You must omit this parameter in earlier versions, 3562 and you may omit it in any version. If you require this 3563 parameter, the manifest key 3564 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3565 can ensure that your extension won't be run in an earlier browser version. 3566 </dd> 3567 3568 <!-- OBJECT PROPERTIES --> 3569 <dd style="display: none; "> 3570 <dl> 3571 <div> 3572 <div> 3573 </div> 3574 </div> 3575 </dl> 3576 </dd> 3577 3578 <!-- OBJECT METHODS --> 3579 <dd style="display: none; "> 3580 <div></div> 3581 </dd> 3582 3583 <!-- OBJECT EVENT FIELDS --> 3584 <dd style="display: none; "> 3585 <div></div> 3586 </dd> 3587 3588 <!-- FUNCTION PARAMETERS --> 3589 <dd style="display: none; "> 3590 <div></div> 3591 </dd> 3592 3593 </div> 3594 </div> 3595 </dl> 3596 </dd> 3597 3598 <!-- OBJECT METHODS --> 3599 <dd style="display: none; "> 3600 <div></div> 3601 </dd> 3602 3603 <!-- OBJECT EVENT FIELDS --> 3604 <dd style="display: none; "> 3605 <div></div> 3606 </dd> 3607 3608 <!-- FUNCTION PARAMETERS --> 3609 <dd style="display: none; "> 3610 <div></div> 3611 </dd> 3612 3613 </div> 3614 3615 </div><div class="apiItem"> 3616 <a name="type-Event"></a> 3617 <h4>Event</h4> 3618 3619 <div> 3620 <dt> 3621 <var style="display: none; ">paramName</var> 3622 <em> 3623 3624 <!-- TYPE --> 3625 <div style="display:inline"> 3626 ( 3627 <span class="optional" style="display: none; ">optional</span> 3628 <span class="enum" style="display: none; ">enumerated</span> 3629 <span id="typeTemplate"> 3630 <span style="display: none; "> 3631 <a> Type</a> 3632 </span> 3633 <span> 3634 <span style="display: none; "> 3635 array of <span><span></span></span> 3636 </span> 3637 <span>object</span> 3638 <span style="display: none; "></span> 3639 </span> 3640 </span> 3641 ) 3642 </div> 3643 3644 </em> 3645 </dt> 3646 <dd class="todo" style="display: none; "> 3647 Undocumented. 3648 </dd> 3649 <dd>An object which allows the addition and removal of listeners for a Chrome event.</dd> 3650 <dd style="display: none; "> 3651 This parameter was added in version 3652 <b><span></span></b>. 3653 You must omit this parameter in earlier versions, 3654 and you may omit it in any version. If you require this 3655 parameter, the manifest key 3656 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3657 can ensure that your extension won't be run in an earlier browser version. 3658 </dd> 3659 3660 <!-- OBJECT PROPERTIES --> 3661 <dd> 3662 <dl> 3663 <div> 3664 <div> 3665 <dt> 3666 <var>addListener</var> 3667 <em> 3668 3669 <!-- TYPE --> 3670 <div style="display:inline"> 3671 ( 3672 <span class="optional" style="display: none; ">optional</span> 3673 <span class="enum" style="display: none; ">enumerated</span> 3674 <span id="typeTemplate"> 3675 <span style="display: none; "> 3676 <a> Type</a> 3677 </span> 3678 <span> 3679 <span style="display: none; "> 3680 array of <span><span></span></span> 3681 </span> 3682 <span>function</span> 3683 <span style="display: none; "></span> 3684 </span> 3685 </span> 3686 ) 3687 </div> 3688 3689 </em> 3690 </dt> 3691 <dd class="todo"> 3692 Undocumented. 3693 </dd> 3694 <dd style="display: none; "> 3695 Description of this parameter from the json schema. 3696 </dd> 3697 <dd style="display: none; "> 3698 This parameter was added in version 3699 <b><span></span></b>. 3700 You must omit this parameter in earlier versions, 3701 and you may omit it in any version. If you require this 3702 parameter, the manifest key 3703 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3704 can ensure that your extension won't be run in an earlier browser version. 3705 </dd> 3706 3707 <!-- OBJECT PROPERTIES --> 3708 <dd style="display: none; "> 3709 <dl> 3710 <div> 3711 <div> 3712 </div> 3713 </div> 3714 </dl> 3715 </dd> 3716 3717 <!-- OBJECT METHODS --> 3718 <dd style="display: none; "> 3719 <div></div> 3720 </dd> 3721 3722 <!-- OBJECT EVENT FIELDS --> 3723 <dd style="display: none; "> 3724 <div></div> 3725 </dd> 3726 3727 <!-- FUNCTION PARAMETERS --> 3728 <dd style="display: none; "> 3729 <div></div> 3730 </dd> 3731 3732 </div> 3733 </div><div> 3734 <div> 3735 <dt> 3736 <var>removeListener</var> 3737 <em> 3738 3739 <!-- TYPE --> 3740 <div style="display:inline"> 3741 ( 3742 <span class="optional" style="display: none; ">optional</span> 3743 <span class="enum" style="display: none; ">enumerated</span> 3744 <span id="typeTemplate"> 3745 <span style="display: none; "> 3746 <a> Type</a> 3747 </span> 3748 <span> 3749 <span style="display: none; "> 3750 array of <span><span></span></span> 3751 </span> 3752 <span>function</span> 3753 <span style="display: none; "></span> 3754 </span> 3755 </span> 3756 ) 3757 </div> 3758 3759 </em> 3760 </dt> 3761 <dd class="todo"> 3762 Undocumented. 3763 </dd> 3764 <dd style="display: none; "> 3765 Description of this parameter from the json schema. 3766 </dd> 3767 <dd style="display: none; "> 3768 This parameter was added in version 3769 <b><span></span></b>. 3770 You must omit this parameter in earlier versions, 3771 and you may omit it in any version. If you require this 3772 parameter, the manifest key 3773 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3774 can ensure that your extension won't be run in an earlier browser version. 3775 </dd> 3776 3777 <!-- OBJECT PROPERTIES --> 3778 <dd style="display: none; "> 3779 <dl> 3780 <div> 3781 <div> 3782 </div> 3783 </div> 3784 </dl> 3785 </dd> 3786 3787 <!-- OBJECT METHODS --> 3788 <dd style="display: none; "> 3789 <div></div> 3790 </dd> 3791 3792 <!-- OBJECT EVENT FIELDS --> 3793 <dd style="display: none; "> 3794 <div></div> 3795 </dd> 3796 3797 <!-- FUNCTION PARAMETERS --> 3798 <dd style="display: none; "> 3799 <div></div> 3800 </dd> 3801 3802 </div> 3803 </div><div> 3804 <div> 3805 <dt> 3806 <var>hasListener</var> 3807 <em> 3808 3809 <!-- TYPE --> 3810 <div style="display:inline"> 3811 ( 3812 <span class="optional" style="display: none; ">optional</span> 3813 <span class="enum" style="display: none; ">enumerated</span> 3814 <span id="typeTemplate"> 3815 <span style="display: none; "> 3816 <a> Type</a> 3817 </span> 3818 <span> 3819 <span style="display: none; "> 3820 array of <span><span></span></span> 3821 </span> 3822 <span>function</span> 3823 <span style="display: none; "></span> 3824 </span> 3825 </span> 3826 ) 3827 </div> 3828 3829 </em> 3830 </dt> 3831 <dd class="todo"> 3832 Undocumented. 3833 </dd> 3834 <dd style="display: none; "> 3835 Description of this parameter from the json schema. 3836 </dd> 3837 <dd style="display: none; "> 3838 This parameter was added in version 3839 <b><span></span></b>. 3840 You must omit this parameter in earlier versions, 3841 and you may omit it in any version. If you require this 3842 parameter, the manifest key 3843 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3844 can ensure that your extension won't be run in an earlier browser version. 3845 </dd> 3846 3847 <!-- OBJECT PROPERTIES --> 3848 <dd style="display: none; "> 3849 <dl> 3850 <div> 3851 <div> 3852 </div> 3853 </div> 3854 </dl> 3855 </dd> 3856 3857 <!-- OBJECT METHODS --> 3858 <dd style="display: none; "> 3859 <div></div> 3860 </dd> 3861 3862 <!-- OBJECT EVENT FIELDS --> 3863 <dd style="display: none; "> 3864 <div></div> 3865 </dd> 3866 3867 <!-- FUNCTION PARAMETERS --> 3868 <dd style="display: none; "> 3869 <div></div> 3870 </dd> 3871 3872 </div> 3873 </div><div> 3874 <div> 3875 <dt> 3876 <var>hasListeners</var> 3877 <em> 3878 3879 <!-- TYPE --> 3880 <div style="display:inline"> 3881 ( 3882 <span class="optional" style="display: none; ">optional</span> 3883 <span class="enum" style="display: none; ">enumerated</span> 3884 <span id="typeTemplate"> 3885 <span style="display: none; "> 3886 <a> Type</a> 3887 </span> 3888 <span> 3889 <span style="display: none; "> 3890 array of <span><span></span></span> 3891 </span> 3892 <span>function</span> 3893 <span style="display: none; "></span> 3894 </span> 3895 </span> 3896 ) 3897 </div> 3898 3899 </em> 3900 </dt> 3901 <dd class="todo"> 3902 Undocumented. 3903 </dd> 3904 <dd style="display: none; "> 3905 Description of this parameter from the json schema. 3906 </dd> 3907 <dd style="display: none; "> 3908 This parameter was added in version 3909 <b><span></span></b>. 3910 You must omit this parameter in earlier versions, 3911 and you may omit it in any version. If you require this 3912 parameter, the manifest key 3913 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3914 can ensure that your extension won't be run in an earlier browser version. 3915 </dd> 3916 3917 <!-- OBJECT PROPERTIES --> 3918 <dd style="display: none; "> 3919 <dl> 3920 <div> 3921 <div> 3922 </div> 3923 </div> 3924 </dl> 3925 </dd> 3926 3927 <!-- OBJECT METHODS --> 3928 <dd style="display: none; "> 3929 <div></div> 3930 </dd> 3931 3932 <!-- OBJECT EVENT FIELDS --> 3933 <dd style="display: none; "> 3934 <div></div> 3935 </dd> 3936 3937 <!-- FUNCTION PARAMETERS --> 3938 <dd style="display: none; "> 3939 <div></div> 3940 </dd> 3941 3942 </div> 3943 </div> 3944 </dl> 3945 </dd> 3946 3947 <!-- OBJECT METHODS --> 3948 <dd style="display: none; "> 3949 <div></div> 3950 </dd> 3951 3952 <!-- OBJECT EVENT FIELDS --> 3953 <dd style="display: none; "> 3954 <div></div> 3955 </dd> 3956 3957 <!-- FUNCTION PARAMETERS --> 3958 <dd style="display: none; "> 3959 <div></div> 3960 </dd> 3961 3962 </div> 3963 3964 </div><div class="apiItem"> 3965 <a name="type-Port"></a> 3966 <h4>Port</h4> 3967 3968 <div> 3969 <dt> 3970 <var style="display: none; ">paramName</var> 3971 <em> 3972 3973 <!-- TYPE --> 3974 <div style="display:inline"> 3975 ( 3976 <span class="optional" style="display: none; ">optional</span> 3977 <span class="enum" style="display: none; ">enumerated</span> 3978 <span id="typeTemplate"> 3979 <span style="display: none; "> 3980 <a> Type</a> 3981 </span> 3982 <span> 3983 <span style="display: none; "> 3984 array of <span><span></span></span> 3985 </span> 3986 <span>object</span> 3987 <span style="display: none; "></span> 3988 </span> 3989 </span> 3990 ) 3991 </div> 3992 3993 </em> 3994 </dt> 3995 <dd class="todo" style="display: none; "> 3996 Undocumented. 3997 </dd> 3998 <dd>An object which allows two way communication with other pages.</dd> 3999 <dd style="display: none; "> 4000 This parameter was added in version 4001 <b><span></span></b>. 4002 You must omit this parameter in earlier versions, 4003 and you may omit it in any version. If you require this 4004 parameter, the manifest key 4005 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4006 can ensure that your extension won't be run in an earlier browser version. 4007 </dd> 4008 4009 <!-- OBJECT PROPERTIES --> 4010 <dd> 4011 <dl> 4012 <div> 4013 <div> 4014 <dt> 4015 <var>name</var> 4016 <em> 4017 4018 <!-- TYPE --> 4019 <div style="display:inline"> 4020 ( 4021 <span class="optional" style="display: none; ">optional</span> 4022 <span class="enum" style="display: none; ">enumerated</span> 4023 <span id="typeTemplate"> 4024 <span style="display: none; "> 4025 <a> Type</a> 4026 </span> 4027 <span> 4028 <span style="display: none; "> 4029 array of <span><span></span></span> 4030 </span> 4031 <span>string</span> 4032 <span style="display: none; "></span> 4033 </span> 4034 </span> 4035 ) 4036 </div> 4037 4038 </em> 4039 </dt> 4040 <dd class="todo"> 4041 Undocumented. 4042 </dd> 4043 <dd style="display: none; "> 4044 Description of this parameter from the json schema. 4045 </dd> 4046 <dd style="display: none; "> 4047 This parameter was added in version 4048 <b><span></span></b>. 4049 You must omit this parameter in earlier versions, 4050 and you may omit it in any version. If you require this 4051 parameter, the manifest key 4052 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4053 can ensure that your extension won't be run in an earlier browser version. 4054 </dd> 4055 4056 <!-- OBJECT PROPERTIES --> 4057 <dd style="display: none; "> 4058 <dl> 4059 <div> 4060 <div> 4061 </div> 4062 </div> 4063 </dl> 4064 </dd> 4065 4066 <!-- OBJECT METHODS --> 4067 <dd style="display: none; "> 4068 <div></div> 4069 </dd> 4070 4071 <!-- OBJECT EVENT FIELDS --> 4072 <dd style="display: none; "> 4073 <div></div> 4074 </dd> 4075 4076 <!-- FUNCTION PARAMETERS --> 4077 <dd style="display: none; "> 4078 <div></div> 4079 </dd> 4080 4081 </div> 4082 </div><div> 4083 <div> 4084 <dt> 4085 <var>onDisconnect</var> 4086 <em> 4087 4088 <!-- TYPE --> 4089 <div style="display:inline"> 4090 ( 4091 <span class="optional" style="display: none; ">optional</span> 4092 <span class="enum" style="display: none; ">enumerated</span> 4093 <span id="typeTemplate"> 4094 <span> 4095 <a href="extension.html#type-Event">Event</a> 4096 </span> 4097 <span style="display: none; "> 4098 <span> 4099 array of <span><span></span></span> 4100 </span> 4101 <span>paramType</span> 4102 <span></span> 4103 </span> 4104 </span> 4105 ) 4106 </div> 4107 4108 </em> 4109 </dt> 4110 <dd class="todo"> 4111 Undocumented. 4112 </dd> 4113 <dd style="display: none; "> 4114 Description of this parameter from the json schema. 4115 </dd> 4116 <dd style="display: none; "> 4117 This parameter was added in version 4118 <b><span></span></b>. 4119 You must omit this parameter in earlier versions, 4120 and you may omit it in any version. If you require this 4121 parameter, the manifest key 4122 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4123 can ensure that your extension won't be run in an earlier browser version. 4124 </dd> 4125 4126 <!-- OBJECT PROPERTIES --> 4127 <dd style="display: none; "> 4128 <dl> 4129 <div> 4130 <div> 4131 </div> 4132 </div> 4133 </dl> 4134 </dd> 4135 4136 <!-- OBJECT METHODS --> 4137 <dd style="display: none; "> 4138 <div></div> 4139 </dd> 4140 4141 <!-- OBJECT EVENT FIELDS --> 4142 <dd style="display: none; "> 4143 <div></div> 4144 </dd> 4145 4146 <!-- FUNCTION PARAMETERS --> 4147 <dd style="display: none; "> 4148 <div></div> 4149 </dd> 4150 4151 </div> 4152 </div><div> 4153 <div> 4154 <dt> 4155 <var>onMessage</var> 4156 <em> 4157 4158 <!-- TYPE --> 4159 <div style="display:inline"> 4160 ( 4161 <span class="optional" style="display: none; ">optional</span> 4162 <span class="enum" style="display: none; ">enumerated</span> 4163 <span id="typeTemplate"> 4164 <span> 4165 <a href="extension.html#type-Event">Event</a> 4166 </span> 4167 <span style="display: none; "> 4168 <span> 4169 array of <span><span></span></span> 4170 </span> 4171 <span>paramType</span> 4172 <span></span> 4173 </span> 4174 </span> 4175 ) 4176 </div> 4177 4178 </em> 4179 </dt> 4180 <dd class="todo"> 4181 Undocumented. 4182 </dd> 4183 <dd style="display: none; "> 4184 Description of this parameter from the json schema. 4185 </dd> 4186 <dd style="display: none; "> 4187 This parameter was added in version 4188 <b><span></span></b>. 4189 You must omit this parameter in earlier versions, 4190 and you may omit it in any version. If you require this 4191 parameter, the manifest key 4192 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4193 can ensure that your extension won't be run in an earlier browser version. 4194 </dd> 4195 4196 <!-- OBJECT PROPERTIES --> 4197 <dd style="display: none; "> 4198 <dl> 4199 <div> 4200 <div> 4201 </div> 4202 </div> 4203 </dl> 4204 </dd> 4205 4206 <!-- OBJECT METHODS --> 4207 <dd style="display: none; "> 4208 <div></div> 4209 </dd> 4210 4211 <!-- OBJECT EVENT FIELDS --> 4212 <dd style="display: none; "> 4213 <div></div> 4214 </dd> 4215 4216 <!-- FUNCTION PARAMETERS --> 4217 <dd style="display: none; "> 4218 <div></div> 4219 </dd> 4220 4221 </div> 4222 </div><div> 4223 <div> 4224 <dt> 4225 <var>postMessage</var> 4226 <em> 4227 4228 <!-- TYPE --> 4229 <div style="display:inline"> 4230 ( 4231 <span class="optional" style="display: none; ">optional</span> 4232 <span class="enum" style="display: none; ">enumerated</span> 4233 <span id="typeTemplate"> 4234 <span style="display: none; "> 4235 <a> Type</a> 4236 </span> 4237 <span> 4238 <span style="display: none; "> 4239 array of <span><span></span></span> 4240 </span> 4241 <span>function</span> 4242 <span style="display: none; "></span> 4243 </span> 4244 </span> 4245 ) 4246 </div> 4247 4248 </em> 4249 </dt> 4250 <dd class="todo"> 4251 Undocumented. 4252 </dd> 4253 <dd style="display: none; "> 4254 Description of this parameter from the json schema. 4255 </dd> 4256 <dd style="display: none; "> 4257 This parameter was added in version 4258 <b><span></span></b>. 4259 You must omit this parameter in earlier versions, 4260 and you may omit it in any version. If you require this 4261 parameter, the manifest key 4262 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4263 can ensure that your extension won't be run in an earlier browser version. 4264 </dd> 4265 4266 <!-- OBJECT PROPERTIES --> 4267 <dd style="display: none; "> 4268 <dl> 4269 <div> 4270 <div> 4271 </div> 4272 </div> 4273 </dl> 4274 </dd> 4275 4276 <!-- OBJECT METHODS --> 4277 <dd style="display: none; "> 4278 <div></div> 4279 </dd> 4280 4281 <!-- OBJECT EVENT FIELDS --> 4282 <dd style="display: none; "> 4283 <div></div> 4284 </dd> 4285 4286 <!-- FUNCTION PARAMETERS --> 4287 <dd style="display: none; "> 4288 <div></div> 4289 </dd> 4290 4291 </div> 4292 </div><div> 4293 <div> 4294 <dt> 4295 <var>sender</var> 4296 <em> 4297 4298 <!-- TYPE --> 4299 <div style="display:inline"> 4300 ( 4301 <span class="optional">optional</span> 4302 <span class="enum" style="display: none; ">enumerated</span> 4303 <span id="typeTemplate"> 4304 <span> 4305 <a href="extension.html#type-MessageSender">MessageSender</a> 4306 </span> 4307 <span style="display: none; "> 4308 <span> 4309 array of <span><span></span></span> 4310 </span> 4311 <span>paramType</span> 4312 <span></span> 4313 </span> 4314 </span> 4315 ) 4316 </div> 4317 4318 </em> 4319 </dt> 4320 <dd class="todo" style="display: none; "> 4321 Undocumented. 4322 </dd> 4323 <dd>This property will <b>only</b> be present on ports passed to onConnect/onConnectExternal listeners.</dd> 4324 <dd style="display: none; "> 4325 This parameter was added in version 4326 <b><span></span></b>. 4327 You must omit this parameter in earlier versions, 4328 and you may omit it in any version. If you require this 4329 parameter, the manifest key 4330 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4331 can ensure that your extension won't be run in an earlier browser version. 4332 </dd> 4333 4334 <!-- OBJECT PROPERTIES --> 4335 <dd style="display: none; "> 4336 <dl> 4337 <div> 4338 <div> 4339 </div> 4340 </div> 4341 </dl> 4342 </dd> 4343 4344 <!-- OBJECT METHODS --> 4345 <dd style="display: none; "> 4346 <div></div> 4347 </dd> 4348 4349 <!-- OBJECT EVENT FIELDS --> 4350 <dd style="display: none; "> 4351 <div></div> 4352 </dd> 4353 4354 <!-- FUNCTION PARAMETERS --> 4355 <dd style="display: none; "> 4356 <div></div> 4357 </dd> 4358 4359 </div> 4360 </div> 4361 </dl> 4362 </dd> 4363 4364 <!-- OBJECT METHODS --> 4365 <dd style="display: none; "> 4366 <div></div> 4367 </dd> 4368 4369 <!-- OBJECT EVENT FIELDS --> 4370 <dd style="display: none; "> 4371 <div></div> 4372 </dd> 4373 4374 <!-- FUNCTION PARAMETERS --> 4375 <dd style="display: none; "> 4376 <div></div> 4377 </dd> 4378 4379 </div> 4380 4381 </div> <!-- /apiItem --> 4382 4383 </div> <!-- /apiGroup --> 4384 4385 </div> <!-- /apiPage --> 4386 </div> <!-- /gc-pagecontent --> 4387 </div> <!-- /g-section --> 4388 </div> <!-- /codesiteContent --> 4389 <div id="gc-footer" --=""> 4390 <div class="text"> 4391 <p> 4392 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 4393 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 4394 Attribution 3.0 License</a>, and code samples are licensed under the 4395 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 4396 </p> 4397 <p> 4398 2011 Google 4399 </p> 4400 4401 <!-- begin analytics --> 4402 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 4403 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 4404 4405 <script type="text/javascript"> 4406 // chrome doc tracking 4407 try { 4408 var engdocs = _gat._getTracker("YT-10763712-2"); 4409 engdocs._trackPageview(); 4410 } catch(err) {} 4411 4412 // code.google.com site-wide tracking 4413 try { 4414 _uacct="UA-18071-1"; 4415 _uanchor=1; 4416 _uff=0; 4417 urchinTracker(); 4418 } 4419 catch(e) {/* urchinTracker not available. */} 4420 </script> 4421 <!-- end analytics --> 4422 </div> 4423 </div> <!-- /gc-footer --> 4424 </div> <!-- /gc-container --> 4425 </body></html> 4426
