extension.html revision 513209b27ff55e2841eac0e4120199c23acce758
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 <!-- FUNCTION PARAMETERS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 </div> <!-- /VALUE --> 90 91 <div id="functionParametersTemplate"> 92 <h5>Parameters</h5> 93 <dl> 94 <div> 95 <div> 96 </div> 97 </div> 98 </dl> 99 </div> 100 </div> <!-- /SUBTEMPLATES --> 101 102 <a id="top"></a> 103 <div id="skipto"> 104 <a href="#gc-pagecontent">Skip to page content</a> 105 <a href="#gc-toc">Skip to main navigation</a> 106 </div> 107 <!-- API HEADER --> 108 <table id="header" width="100%" cellspacing="0" border="0"> 109 <tbody><tr> 110 <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> 111 <td valign="middle" width="100%" style="padding-left:0.6em;"> 112 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 113 <div id="gsc-search-box"> 114 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 115 <input type="hidden" name="ie" value="UTF-8"> 116 <input type="text" name="q" value="" size="55"> 117 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 118 <br> 119 <span class="greytext">e.g. "page action" or "tabs"</span> 120 </div> 121 </form> 122 123 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 124 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 125 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 126 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 127 </td> 128 </tr> 129 </tbody></table> 130 131 <div id="codesiteContent" class=""> 132 133 <a id="gc-topnav-anchor"></a> 134 <div id="gc-topnav"> 135 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 136 <ul id="home" class="gc-topnav-tabs"> 137 <li id="home_link"> 138 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 139 </li> 140 <li id="docs_link"> 141 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 142 </li> 143 <li id="faq_link"> 144 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 145 </li> 146 <li id="samples_link"> 147 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 148 </li> 149 <li id="group_link"> 150 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 151 </li> 152 </ul> 153 </div> <!-- end gc-topnav --> 154 155 <div class="g-section g-tpl-170"> 156 <!-- SIDENAV --> 157 <div class="g-unit g-first" id="gc-toc"> 158 <ul> 159 <li><a href="getstarted.html">Getting Started</a></li> 160 <li><a href="overview.html">Overview</a></li> 161 <li><a href="whats_new.html">What's New?</a></li> 162 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 163 <ul> 164 <li>Browser UI 165 <ul> 166 <li><a href="browserAction.html">Browser Actions</a></li> 167 <li><a href="contextMenus.html">Context Menus</a></li> 168 <li><a href="notifications.html">Desktop Notifications</a></li> 169 <li><a href="options.html">Options Pages</a></li> 170 <li><a href="override.html">Override Pages</a></li> 171 <li><a href="pageAction.html">Page Actions</a></li> 172 <li><a href="themes.html">Themes</a></li> 173 </ul> 174 </li> 175 <li>Browser Interaction 176 <ul> 177 <li><a href="bookmarks.html">Bookmarks</a></li> 178 <li><a href="cookies.html">Cookies</a></li> 179 <li><a href="events.html">Events</a></li> 180 <li><a href="history.html">History</a></li> 181 <li><a href="management.html">Management</a></li> 182 <li><a href="tabs.html">Tabs</a></li> 183 <li><a href="windows.html">Windows</a></li> 184 </ul> 185 </li> 186 <li>Implementation 187 <ul> 188 <li><a href="a11y.html">Accessibility</a></li> 189 <li><a href="background_pages.html">Background Pages</a></li> 190 <li><a href="content_scripts.html">Content Scripts</a></li> 191 <li><a href="xhr.html">Cross-Origin XHR</a></li> 192 <li><a href="idle.html">Idle</a></li> 193 <li><a href="i18n.html">Internationalization</a></li> 194 <li><a href="messaging.html">Message Passing</a></li> 195 <li><a href="npapi.html">NPAPI Plugins</a></li> 196 </ul> 197 </li> 198 <li>Finishing 199 <ul> 200 <li><a href="hosting.html">Hosting</a></li> 201 <li><a href="external_extensions.html">Other Deployment Options</a></li> 202 </ul> 203 </li> 204 </ul> 205 </li> 206 <li><h2><a href="tutorials.html">Tutorials</a></h2> 207 <ul> 208 <li><a href="tut_debugging.html">Debugging</a></li> 209 <li><a href="tut_analytics.html">Google Analytics</a></li> 210 <li><a href="tut_oauth.html">OAuth</a></li> 211 </ul> 212 </li> 213 <li><h2>Reference</h2> 214 <ul> 215 <li>Formats 216 <ul> 217 <li><a href="manifest.html">Manifest Files</a></li> 218 <li><a href="match_patterns.html">Match Patterns</a></li> 219 <!-- <li>Packages (.crx)</li> --> 220 </ul> 221 </li> 222 <li><a href="api_index.html">chrome.* APIs</a></li> 223 <li><a href="api_other.html">Other APIs</a></li> 224 </ul> 225 </li> 226 <li><h2><a href="samples.html">Samples</a></h2></li> 227 </ul> 228 </div> 229 <script> 230 initToggles(); 231 </script> 232 233 <div class="g-unit" id="gc-pagecontent"> 234 <div id="pageTitle"> 235 <h1 class="page_title">chrome.extension</h1> 236 </div> 237 <!-- TABLE OF CONTENTS --> 238 <div id="toc"> 239 <h2>Contents</h2> 240 <ol> 241 <li> 242 <a href="#content scripts">Support for content scripts</a> 243 <ol> 244 <li style="display: none; "> 245 <a>h3Name</a> 246 </li> 247 </ol> 248 </li> 249 <li> 250 <a href="#apiReference">API reference: chrome.extension</a> 251 <ol> 252 <li> 253 <a href="#properties">Properties</a> 254 <ol> 255 <li> 256 <a href="#property-lastError">lastError</a> 257 </li><li> 258 <a href="#property-inIncognitoContext">inIncognitoContext</a> 259 </li> 260 </ol> 261 </li> 262 <li> 263 <a href="#methods">Methods</a> 264 <ol> 265 <li> 266 <a href="#method-connect">connect</a> 267 </li><li> 268 <a href="#method-getBackgroundPage">getBackgroundPage</a> 269 </li><li style="display: none; "> 270 <a href="#method-anchor">methodName</a> 271 </li><li style="display: none; "> 272 <a href="#method-anchor">methodName</a> 273 </li><li> 274 <a href="#method-getURL">getURL</a> 275 </li><li> 276 <a href="#method-getViews">getViews</a> 277 </li><li> 278 <a href="#method-sendRequest">sendRequest</a> 279 </li> 280 </ol> 281 </li> 282 <li> 283 <a href="#events">Events</a> 284 <ol> 285 <li> 286 <a href="#event-onConnect">onConnect</a> 287 </li><li> 288 <a href="#event-onConnectExternal">onConnectExternal</a> 289 </li><li> 290 <a href="#event-onRequest">onRequest</a> 291 </li><li> 292 <a href="#event-onRequestExternal">onRequestExternal</a> 293 </li> 294 </ol> 295 </li> 296 <li> 297 <a href="#types">Types</a> 298 <ol> 299 <li> 300 <a href="#type-MessageSender">MessageSender</a> 301 </li><li> 302 <a href="#type-Event">Event</a> 303 </li><li> 304 <a href="#type-Port">Port</a> 305 </li> 306 </ol> 307 </li> 308 </ol> 309 </li> 310 </ol> 311 </div> 312 <!-- /TABLE OF CONTENTS --> 313 314 <!-- Standard content lead-in for experimental API pages --> 315 <p id="classSummary" style="display: none; "> 316 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 317 </p> 318 319 <!-- STATIC CONTENT PLACEHOLDER --> 320 <div id="static"><!-- BEGIN AUTHORED CONTENT --> 321<p id="classSummary"> 322The <code>chrome.extension</code> module 323has utilities that can be used by any extension page. 324It includes support for exchanging messages 325between an extension and its content scripts 326or between extensions, 327as described in detail in 328<a href="messaging.html">Message Passing</a>. 329</p> 330 331<h2 id="content scripts">Support for content scripts</h2> 332<p> 333Unlike the other chrome.* APIs, 334parts of <code>chrome.extension</code> 335can be used by content scripts: 336</p> 337 338<dl> 339 <dt> 340 <a href="#method-sendRequest"><code>sendRequest()</code></a> and 341 <a href="#event-onRequest"><code>onRequest</code></a> 342 </dt> 343 <dd> 344 Simple communication with extension pages 345 </dd> 346 <dt> 347 <a href="#method-connect"><code>connect()</code></a> and 348 <a href="#event-onConnect"><code>onConnect</code></a> 349 </dt> 350 <dd> 351 Extended communication with extension pages 352 </dd> 353 <dt> 354 <a href="#method-getURL"><code>getURL()</code></a> 355 </dt> 356 <dd> 357 Access to extension resources such as image files 358 </dd> 359</dl> 360 361<p> 362For details, see 363<a href="content_scripts.html">Content Scripts</a>. 364</p> 365 366<!-- END AUTHORED CONTENT --> 367</div> 368 369 <!-- API PAGE --> 370 <div class="apiPage"> 371 <a name="apiReference"></a> 372 <h2>API reference: chrome.extension</h2> 373 374 <!-- PROPERTIES --> 375 <div class="apiGroup"> 376 <a name="properties"></a> 377 <h3 id="properties">Properties</h3> 378 379 <div> 380 <a name="property-lastError"></a> 381 <h4>lastError</h4> 382 <div class="summary"> 383 <!-- Note: intentionally longer 80 columns --> 384 <span>chrome.extension.</span><span>lastError</span> 385 </div> 386 <div> 387 <dt> 388 <var>lastError</var> 389 <em> 390 391 <!-- TYPE --> 392 <div style="display:inline"> 393 ( 394 <span class="optional">optional</span> 395 <span class="enum" style="display: none; ">enumerated</span> 396 <span id="typeTemplate"> 397 <span style="display: none; "> 398 <a> Type</a> 399 </span> 400 <span> 401 <span style="display: none; "> 402 array of <span><span></span></span> 403 </span> 404 <span>object</span> 405 <span style="display: none; "></span> 406 </span> 407 </span> 408 ) 409 </div> 410 411 </em> 412 </dt> 413 <dd class="todo" style="display: none; "> 414 Undocumented. 415 </dd> 416 <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> 417 <dd style="display: none; "> 418 This parameter was added in version 419 <b><span></span></b>. 420 You must omit this parameter in earlier versions, 421 and you may omit it in any version. If you require this 422 parameter, the manifest key 423 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 424 can ensure that your extension won't be run in an earlier browser version. 425 </dd> 426 427 <!-- OBJECT PROPERTIES --> 428 <dd> 429 <dl> 430 <div> 431 <div> 432 <dt> 433 <var>message</var> 434 <em> 435 436 <!-- TYPE --> 437 <div style="display:inline"> 438 ( 439 <span class="optional" style="display: none; ">optional</span> 440 <span class="enum" style="display: none; ">enumerated</span> 441 <span id="typeTemplate"> 442 <span style="display: none; "> 443 <a> Type</a> 444 </span> 445 <span> 446 <span style="display: none; "> 447 array of <span><span></span></span> 448 </span> 449 <span>string</span> 450 <span style="display: none; "></span> 451 </span> 452 </span> 453 ) 454 </div> 455 456 </em> 457 </dt> 458 <dd class="todo" style="display: none; "> 459 Undocumented. 460 </dd> 461 <dd>Description of the error that has taken place.</dd> 462 <dd style="display: none; "> 463 This parameter was added in version 464 <b><span></span></b>. 465 You must omit this parameter in earlier versions, 466 and you may omit it in any version. If you require this 467 parameter, the manifest key 468 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 469 can ensure that your extension won't be run in an earlier browser version. 470 </dd> 471 472 <!-- OBJECT PROPERTIES --> 473 <dd style="display: none; "> 474 <dl> 475 <div> 476 <div> 477 </div> 478 </div> 479 </dl> 480 </dd> 481 482 <!-- FUNCTION PARAMETERS --> 483 <dd style="display: none; "> 484 <div></div> 485 </dd> 486 487 </div> 488 </div> 489 </dl> 490 </dd> 491 492 <!-- FUNCTION PARAMETERS --> 493 <dd style="display: none; "> 494 <div></div> 495 </dd> 496 497 </div> 498 </div><div> 499 <a name="property-inIncognitoContext"></a> 500 <h4>inIncognitoContext</h4> 501 <div class="summary"> 502 <!-- Note: intentionally longer 80 columns --> 503 <span>chrome.extension.</span><span>inIncognitoContext</span> 504 </div> 505 <div> 506 <dt> 507 <var>inIncognitoContext</var> 508 <em> 509 510 <!-- TYPE --> 511 <div style="display:inline"> 512 ( 513 <span class="optional">optional</span> 514 <span class="enum" style="display: none; ">enumerated</span> 515 <span id="typeTemplate"> 516 <span style="display: none; "> 517 <a> Type</a> 518 </span> 519 <span> 520 <span style="display: none; "> 521 array of <span><span></span></span> 522 </span> 523 <span>object</span> 524 <span style="display: none; "></span> 525 </span> 526 </span> 527 ) 528 </div> 529 530 </em> 531 </dt> 532 <dd class="todo" style="display: none; "> 533 Undocumented. 534 </dd> 535 <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> 536 <dd style="display: none; "> 537 This parameter was added in version 538 <b><span></span></b>. 539 You must omit this parameter in earlier versions, 540 and you may omit it in any version. If you require this 541 parameter, the manifest key 542 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 543 can ensure that your extension won't be run in an earlier browser version. 544 </dd> 545 546 <!-- OBJECT PROPERTIES --> 547 <dd> 548 <dl> 549 <div> 550 <div> 551 <dt> 552 <var>message</var> 553 <em> 554 555 <!-- TYPE --> 556 <div style="display:inline"> 557 ( 558 <span class="optional" style="display: none; ">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>boolean</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 if the page or script is in an incongito process.</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 style="display: none; "> 593 <dl> 594 <div> 595 <div> 596 </div> 597 </div> 598 </dl> 599 </dd> 600 601 <!-- FUNCTION PARAMETERS --> 602 <dd style="display: none; "> 603 <div></div> 604 </dd> 605 606 </div> 607 </div> 608 </dl> 609 </dd> 610 611 <!-- FUNCTION PARAMETERS --> 612 <dd style="display: none; "> 613 <div></div> 614 </dd> 615 616 </div> 617 </div> 618 619 </div> <!-- /apiGroup --> 620 621 <!-- METHODS --> 622 <div class="apiGroup" id="methods"> 623 <a name="methods"></a> 624 <h3>Methods</h3> 625 626 <!-- iterates over all functions --> 627 <div class="apiItem"> 628 <a name="method-connect"></a> <!-- method-anchor --> 629 <h4>connect</h4> 630 631 <div class="summary"><span>Port</span> 632 <!-- Note: intentionally longer 80 columns --> 633 <span>chrome.extension.connect</span>(<span class="optional"><span style="display: none; ">, </span><span>string</span> 634 <var><span>extensionId</span></var></span><span class="optional"><span>, </span><span>object</span> 635 <var><span>connectInfo</span></var></span>)</div> 636 637 <div class="description"> 638 <p class="todo" style="display: none; ">Undocumented.</p> 639 <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> 640 641 <!-- PARAMETERS --> 642 <h4>Parameters</h4> 643 <dl> 644 <div> 645 <div> 646 <dt> 647 <var>extensionId</var> 648 <em> 649 650 <!-- TYPE --> 651 <div style="display:inline"> 652 ( 653 <span class="optional">optional</span> 654 <span class="enum" style="display: none; ">enumerated</span> 655 <span id="typeTemplate"> 656 <span style="display: none; "> 657 <a> Type</a> 658 </span> 659 <span> 660 <span style="display: none; "> 661 array of <span><span></span></span> 662 </span> 663 <span>string</span> 664 <span style="display: none; "></span> 665 </span> 666 </span> 667 ) 668 </div> 669 670 </em> 671 </dt> 672 <dd class="todo" style="display: none; "> 673 Undocumented. 674 </dd> 675 <dd>The extension ID of the extension you want to connect to. If omitted, default is your own extension.</dd> 676 <dd style="display: none; "> 677 This parameter was added in version 678 <b><span></span></b>. 679 You must omit this parameter in earlier versions, 680 and you may omit it in any version. If you require this 681 parameter, the manifest key 682 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 683 can ensure that your extension won't be run in an earlier browser version. 684 </dd> 685 686 <!-- OBJECT PROPERTIES --> 687 <dd style="display: none; "> 688 <dl> 689 <div> 690 <div> 691 </div> 692 </div> 693 </dl> 694 </dd> 695 696 <!-- FUNCTION PARAMETERS --> 697 <dd style="display: none; "> 698 <div></div> 699 </dd> 700 701 </div> 702 </div><div> 703 <div> 704 <dt> 705 <var>connectInfo</var> 706 <em> 707 708 <!-- TYPE --> 709 <div style="display:inline"> 710 ( 711 <span class="optional">optional</span> 712 <span class="enum" style="display: none; ">enumerated</span> 713 <span id="typeTemplate"> 714 <span style="display: none; "> 715 <a> Type</a> 716 </span> 717 <span> 718 <span style="display: none; "> 719 array of <span><span></span></span> 720 </span> 721 <span>object</span> 722 <span style="display: none; "></span> 723 </span> 724 </span> 725 ) 726 </div> 727 728 </em> 729 </dt> 730 <dd class="todo"> 731 Undocumented. 732 </dd> 733 <dd style="display: none; "> 734 Description of this parameter from the json schema. 735 </dd> 736 <dd style="display: none; "> 737 This parameter was added in version 738 <b><span></span></b>. 739 You must omit this parameter in earlier versions, 740 and you may omit it in any version. If you require this 741 parameter, the manifest key 742 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 743 can ensure that your extension won't be run in an earlier browser version. 744 </dd> 745 746 <!-- OBJECT PROPERTIES --> 747 <dd> 748 <dl> 749 <div> 750 <div> 751 <dt> 752 <var>name</var> 753 <em> 754 755 <!-- TYPE --> 756 <div style="display:inline"> 757 ( 758 <span class="optional">optional</span> 759 <span class="enum" style="display: none; ">enumerated</span> 760 <span id="typeTemplate"> 761 <span style="display: none; "> 762 <a> Type</a> 763 </span> 764 <span> 765 <span style="display: none; "> 766 array of <span><span></span></span> 767 </span> 768 <span>string</span> 769 <span style="display: none; "></span> 770 </span> 771 </span> 772 ) 773 </div> 774 775 </em> 776 </dt> 777 <dd class="todo" style="display: none; "> 778 Undocumented. 779 </dd> 780 <dd>Will be passed into onConnect for extension processes that are listening for the connection event.</dd> 781 <dd style="display: none; "> 782 This parameter was added in version 783 <b><span></span></b>. 784 You must omit this parameter in earlier versions, 785 and you may omit it in any version. If you require this 786 parameter, the manifest key 787 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 788 can ensure that your extension won't be run in an earlier browser version. 789 </dd> 790 791 <!-- OBJECT PROPERTIES --> 792 <dd style="display: none; "> 793 <dl> 794 <div> 795 <div> 796 </div> 797 </div> 798 </dl> 799 </dd> 800 801 <!-- FUNCTION PARAMETERS --> 802 <dd style="display: none; "> 803 <div></div> 804 </dd> 805 806 </div> 807 </div> 808 </dl> 809 </dd> 810 811 <!-- FUNCTION PARAMETERS --> 812 <dd style="display: none; "> 813 <div></div> 814 </dd> 815 816 </div> 817 </div> 818 </dl> 819 820 <!-- RETURNS --> 821 <h4>Returns</h4> 822 <dl> 823 <div> 824 <div> 825 <dt> 826 <var style="display: none; ">paramName</var> 827 <em> 828 829 <!-- TYPE --> 830 <div style="display:inline"> 831 ( 832 <span class="optional" style="display: none; ">optional</span> 833 <span class="enum" style="display: none; ">enumerated</span> 834 <span id="typeTemplate"> 835 <span> 836 <a href="extension.html#type-Port">Port</a> 837 </span> 838 <span style="display: none; "> 839 <span> 840 array of <span><span></span></span> 841 </span> 842 <span>paramType</span> 843 <span></span> 844 </span> 845 </span> 846 ) 847 </div> 848 849 </em> 850 </dt> 851 <dd class="todo" style="display: none; "> 852 Undocumented. 853 </dd> 854 <dd>Port through which messages can be sent and received with the extension.</dd> 855 <dd style="display: none; "> 856 This parameter was added in version 857 <b><span></span></b>. 858 You must omit this parameter in earlier versions, 859 and you may omit it in any version. If you require this 860 parameter, the manifest key 861 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 862 can ensure that your extension won't be run in an earlier browser version. 863 </dd> 864 865 <!-- OBJECT PROPERTIES --> 866 <dd style="display: none; "> 867 <dl> 868 <div> 869 <div> 870 </div> 871 </div> 872 </dl> 873 </dd> 874 875 <!-- FUNCTION PARAMETERS --> 876 <dd style="display: none; "> 877 <div></div> 878 </dd> 879 880 </div> 881 </div> 882 </dl> 883 884 <!-- CALLBACK --> 885 <div style="display: none; "> 886 <div> 887 <h4>Callback function</h4> 888 <p> 889 The callback <em>parameter</em> should specify a function 890 that looks like this: 891 </p> 892 <p> 893 If you specify the <em>callback</em> parameter, it should 894 specify a function that looks like this: 895 </p> 896 897 <!-- Note: intentionally longer 80 columns --> 898 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 899 <dl> 900 <div> 901 <div> 902 </div> 903 </div> 904 </dl> 905 </div> 906 </div> 907 908 <!-- MIN_VERSION --> 909 <p style="display: none; "> 910 This function was added in version <b><span></span></b>. 911 If you require this function, the manifest key 912 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 913 can ensure that your extension won't be run in an earlier browser version. 914 </p> 915 </div> <!-- /description --> 916 917 </div><div class="apiItem"> 918 <a name="method-getBackgroundPage"></a> <!-- method-anchor --> 919 <h4>getBackgroundPage</h4> 920 921 <div class="summary"><span>DOMWindow</span> 922 <!-- Note: intentionally longer 80 columns --> 923 <span>chrome.extension.getBackgroundPage</span>(<span style="display: none; "><span>, </span><span></span> 924 <var><span></span></var></span>)</div> 925 926 <div class="description"> 927 <p class="todo" style="display: none; ">Undocumented.</p> 928 <p>Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no backround page.</p> 929 930 <!-- PARAMETERS --> 931 <h4>Parameters</h4> 932 <dl> 933 <div style="display: none; "> 934 <div> 935 </div> 936 </div> 937 </dl> 938 939 <!-- RETURNS --> 940 <h4>Returns</h4> 941 <dl> 942 <div> 943 <div> 944 <dt> 945 <var style="display: none; ">paramName</var> 946 <em> 947 948 <!-- TYPE --> 949 <div style="display:inline"> 950 ( 951 <span class="optional" style="display: none; ">optional</span> 952 <span class="enum" style="display: none; ">enumerated</span> 953 <span id="typeTemplate"> 954 <span style="display: none; "> 955 <a> Type</a> 956 </span> 957 <span> 958 <span style="display: none; "> 959 array of <span><span></span></span> 960 </span> 961 <span>DOMWindow</span> 962 <span style="display: none; "></span> 963 </span> 964 </span> 965 ) 966 </div> 967 968 </em> 969 </dt> 970 <dd class="todo"> 971 Undocumented. 972 </dd> 973 <dd style="display: none; "> 974 Description of this parameter from the json schema. 975 </dd> 976 <dd style="display: none; "> 977 This parameter was added in version 978 <b><span></span></b>. 979 You must omit this parameter in earlier versions, 980 and you may omit it in any version. If you require this 981 parameter, the manifest key 982 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 983 can ensure that your extension won't be run in an earlier browser version. 984 </dd> 985 986 <!-- OBJECT PROPERTIES --> 987 <dd> 988 <dl> 989 <div style="display: none; "> 990 <div> 991 </div> 992 </div> 993 </dl> 994 </dd> 995 996 <!-- FUNCTION PARAMETERS --> 997 <dd style="display: none; "> 998 <div></div> 999 </dd> 1000 1001 </div> 1002 </div> 1003 </dl> 1004 1005 <!-- CALLBACK --> 1006 <div style="display: none; "> 1007 <div> 1008 <h4>Callback function</h4> 1009 <p> 1010 The callback <em>parameter</em> should specify a function 1011 that looks like this: 1012 </p> 1013 <p> 1014 If you specify the <em>callback</em> parameter, it should 1015 specify a function that looks like this: 1016 </p> 1017 1018 <!-- Note: intentionally longer 80 columns --> 1019 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1020 <dl> 1021 <div> 1022 <div> 1023 </div> 1024 </div> 1025 </dl> 1026 </div> 1027 </div> 1028 1029 <!-- MIN_VERSION --> 1030 <p style="display: none; "> 1031 This function was added in version <b><span></span></b>. 1032 If you require this function, the manifest key 1033 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1034 can ensure that your extension won't be run in an earlier browser version. 1035 </p> 1036 </div> <!-- /description --> 1037 1038 </div><div class="apiItem" style="display: none; "> 1039 <a></a> <!-- method-anchor --> 1040 <h4>method name</h4> 1041 1042 <div class="summary"><span>void</span> 1043 <!-- Note: intentionally longer 80 columns --> 1044 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 1045 <var><span></span></var></span>)</div> 1046 1047 <div class="description"> 1048 <p class="todo">Undocumented.</p> 1049 <p> 1050 A description from the json schema def of the function goes here. 1051 </p> 1052 1053 <!-- PARAMETERS --> 1054 <h4>Parameters</h4> 1055 <dl> 1056 <div> 1057 <div> 1058 </div> 1059 </div> 1060 </dl> 1061 1062 <!-- RETURNS --> 1063 <h4>Returns</h4> 1064 <dl> 1065 <div> 1066 <div> 1067 </div> 1068 </div> 1069 </dl> 1070 1071 <!-- CALLBACK --> 1072 <div> 1073 <div> 1074 <h4>Callback function</h4> 1075 <p> 1076 The callback <em>parameter</em> should specify a function 1077 that looks like this: 1078 </p> 1079 <p> 1080 If you specify the <em>callback</em> parameter, it should 1081 specify a function that looks like this: 1082 </p> 1083 1084 <!-- Note: intentionally longer 80 columns --> 1085 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1086 <dl> 1087 <div> 1088 <div> 1089 </div> 1090 </div> 1091 </dl> 1092 </div> 1093 </div> 1094 1095 <!-- MIN_VERSION --> 1096 <p> 1097 This function was added in version <b><span></span></b>. 1098 If you require this function, the manifest key 1099 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1100 can ensure that your extension won't be run in an earlier browser version. 1101 </p> 1102 </div> <!-- /description --> 1103 1104 </div><div class="apiItem" style="display: none; "> 1105 <a></a> <!-- method-anchor --> 1106 <h4>method name</h4> 1107 1108 <div class="summary"><span>void</span> 1109 <!-- Note: intentionally longer 80 columns --> 1110 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 1111 <var><span></span></var></span>)</div> 1112 1113 <div class="description"> 1114 <p class="todo">Undocumented.</p> 1115 <p> 1116 A description from the json schema def of the function goes here. 1117 </p> 1118 1119 <!-- PARAMETERS --> 1120 <h4>Parameters</h4> 1121 <dl> 1122 <div> 1123 <div> 1124 </div> 1125 </div> 1126 </dl> 1127 1128 <!-- RETURNS --> 1129 <h4>Returns</h4> 1130 <dl> 1131 <div> 1132 <div> 1133 </div> 1134 </div> 1135 </dl> 1136 1137 <!-- CALLBACK --> 1138 <div> 1139 <div> 1140 <h4>Callback function</h4> 1141 <p> 1142 The callback <em>parameter</em> should specify a function 1143 that looks like this: 1144 </p> 1145 <p> 1146 If you specify the <em>callback</em> parameter, it should 1147 specify a function that looks like this: 1148 </p> 1149 1150 <!-- Note: intentionally longer 80 columns --> 1151 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1152 <dl> 1153 <div> 1154 <div> 1155 </div> 1156 </div> 1157 </dl> 1158 </div> 1159 </div> 1160 1161 <!-- MIN_VERSION --> 1162 <p> 1163 This function was added in version <b><span></span></b>. 1164 If you require this function, the manifest key 1165 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1166 can ensure that your extension won't be run in an earlier browser version. 1167 </p> 1168 </div> <!-- /description --> 1169 1170 </div><div class="apiItem"> 1171 <a name="method-getURL"></a> <!-- method-anchor --> 1172 <h4>getURL</h4> 1173 1174 <div class="summary"><span>string</span> 1175 <!-- Note: intentionally longer 80 columns --> 1176 <span>chrome.extension.getURL</span>(<span class="null"><span style="display: none; ">, </span><span>string</span> 1177 <var><span>path</span></var></span>)</div> 1178 1179 <div class="description"> 1180 <p class="todo" style="display: none; ">Undocumented.</p> 1181 <p>Converts a relative path within an extension install directory to a fully-qualified URL.</p> 1182 1183 <!-- PARAMETERS --> 1184 <h4>Parameters</h4> 1185 <dl> 1186 <div> 1187 <div> 1188 <dt> 1189 <var>path</var> 1190 <em> 1191 1192 <!-- TYPE --> 1193 <div style="display:inline"> 1194 ( 1195 <span class="optional" style="display: none; ">optional</span> 1196 <span class="enum" style="display: none; ">enumerated</span> 1197 <span id="typeTemplate"> 1198 <span style="display: none; "> 1199 <a> Type</a> 1200 </span> 1201 <span> 1202 <span style="display: none; "> 1203 array of <span><span></span></span> 1204 </span> 1205 <span>string</span> 1206 <span style="display: none; "></span> 1207 </span> 1208 </span> 1209 ) 1210 </div> 1211 1212 </em> 1213 </dt> 1214 <dd class="todo" style="display: none; "> 1215 Undocumented. 1216 </dd> 1217 <dd>A path to a resource within an extension expressed relative to it's install directory.</dd> 1218 <dd style="display: none; "> 1219 This parameter was added in version 1220 <b><span></span></b>. 1221 You must omit this parameter in earlier versions, 1222 and you may omit it in any version. If you require this 1223 parameter, the manifest key 1224 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1225 can ensure that your extension won't be run in an earlier browser version. 1226 </dd> 1227 1228 <!-- OBJECT PROPERTIES --> 1229 <dd style="display: none; "> 1230 <dl> 1231 <div> 1232 <div> 1233 </div> 1234 </div> 1235 </dl> 1236 </dd> 1237 1238 <!-- FUNCTION PARAMETERS --> 1239 <dd style="display: none; "> 1240 <div></div> 1241 </dd> 1242 1243 </div> 1244 </div> 1245 </dl> 1246 1247 <!-- RETURNS --> 1248 <h4>Returns</h4> 1249 <dl> 1250 <div> 1251 <div> 1252 <dt> 1253 <var style="display: none; ">paramName</var> 1254 <em> 1255 1256 <!-- TYPE --> 1257 <div style="display:inline"> 1258 ( 1259 <span class="optional" style="display: none; ">optional</span> 1260 <span class="enum" style="display: none; ">enumerated</span> 1261 <span id="typeTemplate"> 1262 <span style="display: none; "> 1263 <a> Type</a> 1264 </span> 1265 <span> 1266 <span style="display: none; "> 1267 array of <span><span></span></span> 1268 </span> 1269 <span>string</span> 1270 <span style="display: none; "></span> 1271 </span> 1272 </span> 1273 ) 1274 </div> 1275 1276 </em> 1277 </dt> 1278 <dd class="todo" style="display: none; "> 1279 Undocumented. 1280 </dd> 1281 <dd>The fully-qualified URL to the resource.</dd> 1282 <dd style="display: none; "> 1283 This parameter was added in version 1284 <b><span></span></b>. 1285 You must omit this parameter in earlier versions, 1286 and you may omit it in any version. If you require this 1287 parameter, the manifest key 1288 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1289 can ensure that your extension won't be run in an earlier browser version. 1290 </dd> 1291 1292 <!-- OBJECT PROPERTIES --> 1293 <dd style="display: none; "> 1294 <dl> 1295 <div> 1296 <div> 1297 </div> 1298 </div> 1299 </dl> 1300 </dd> 1301 1302 <!-- FUNCTION PARAMETERS --> 1303 <dd style="display: none; "> 1304 <div></div> 1305 </dd> 1306 1307 </div> 1308 </div> 1309 </dl> 1310 1311 <!-- CALLBACK --> 1312 <div style="display: none; "> 1313 <div> 1314 <h4>Callback function</h4> 1315 <p> 1316 The callback <em>parameter</em> should specify a function 1317 that looks like this: 1318 </p> 1319 <p> 1320 If you specify the <em>callback</em> parameter, it should 1321 specify a function that looks like this: 1322 </p> 1323 1324 <!-- Note: intentionally longer 80 columns --> 1325 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1326 <dl> 1327 <div> 1328 <div> 1329 </div> 1330 </div> 1331 </dl> 1332 </div> 1333 </div> 1334 1335 <!-- MIN_VERSION --> 1336 <p style="display: none; "> 1337 This function was added in version <b><span></span></b>. 1338 If you require this function, 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 </p> 1342 </div> <!-- /description --> 1343 1344 </div><div class="apiItem"> 1345 <a name="method-getViews"></a> <!-- method-anchor --> 1346 <h4>getViews</h4> 1347 1348 <div class="summary"><span>array of DOMWindow</span> 1349 <!-- Note: intentionally longer 80 columns --> 1350 <span>chrome.extension.getViews</span>(<span class="optional"><span style="display: none; ">, </span><span>object</span> 1351 <var><span>fetchProperties</span></var></span>)</div> 1352 1353 <div class="description"> 1354 <p class="todo" style="display: none; ">Undocumented.</p> 1355 <p>Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.</p> 1356 1357 <!-- PARAMETERS --> 1358 <h4>Parameters</h4> 1359 <dl> 1360 <div> 1361 <div> 1362 <dt> 1363 <var>fetchProperties</var> 1364 <em> 1365 1366 <!-- TYPE --> 1367 <div style="display:inline"> 1368 ( 1369 <span class="optional">optional</span> 1370 <span class="enum" style="display: none; ">enumerated</span> 1371 <span id="typeTemplate"> 1372 <span style="display: none; "> 1373 <a> Type</a> 1374 </span> 1375 <span> 1376 <span style="display: none; "> 1377 array of <span><span></span></span> 1378 </span> 1379 <span>object</span> 1380 <span style="display: none; "></span> 1381 </span> 1382 </span> 1383 ) 1384 </div> 1385 1386 </em> 1387 </dt> 1388 <dd class="todo"> 1389 Undocumented. 1390 </dd> 1391 <dd style="display: none; "> 1392 Description of this parameter from the json schema. 1393 </dd> 1394 <dd style="display: none; "> 1395 This parameter was added in version 1396 <b><span></span></b>. 1397 You must omit this parameter in earlier versions, 1398 and you may omit it in any version. If you require this 1399 parameter, the manifest key 1400 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1401 can ensure that your extension won't be run in an earlier browser version. 1402 </dd> 1403 1404 <!-- OBJECT PROPERTIES --> 1405 <dd> 1406 <dl> 1407 <div> 1408 <div> 1409 <dt> 1410 <var>type</var> 1411 <em> 1412 1413 <!-- TYPE --> 1414 <div style="display:inline"> 1415 ( 1416 <span class="optional">optional</span> 1417 <span class="enum">enumerated</span> 1418 <span id="typeTemplate"> 1419 <span style="display: none; "> 1420 <a> Type</a> 1421 </span> 1422 <span> 1423 <span style="display: none; "> 1424 array of <span><span></span></span> 1425 </span> 1426 <span>string</span> 1427 <span>["tab", "infobar", "notification", "popup"]</span> 1428 </span> 1429 </span> 1430 ) 1431 </div> 1432 1433 </em> 1434 </dt> 1435 <dd class="todo" style="display: none; "> 1436 Undocumented. 1437 </dd> 1438 <dd>The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'infobar', 'notification', 'popup'.</dd> 1439 <dd style="display: none; "> 1440 This parameter was added in version 1441 <b><span></span></b>. 1442 You must omit this parameter in earlier versions, 1443 and you may omit it in any version. If you require this 1444 parameter, the manifest key 1445 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1446 can ensure that your extension won't be run in an earlier browser version. 1447 </dd> 1448 1449 <!-- OBJECT PROPERTIES --> 1450 <dd style="display: none; "> 1451 <dl> 1452 <div> 1453 <div> 1454 </div> 1455 </div> 1456 </dl> 1457 </dd> 1458 1459 <!-- FUNCTION PARAMETERS --> 1460 <dd style="display: none; "> 1461 <div></div> 1462 </dd> 1463 1464 </div> 1465 </div><div> 1466 <div> 1467 <dt> 1468 <var>windowId</var> 1469 <em> 1470 1471 <!-- TYPE --> 1472 <div style="display:inline"> 1473 ( 1474 <span class="optional">optional</span> 1475 <span class="enum" style="display: none; ">enumerated</span> 1476 <span id="typeTemplate"> 1477 <span style="display: none; "> 1478 <a> Type</a> 1479 </span> 1480 <span> 1481 <span style="display: none; "> 1482 array of <span><span></span></span> 1483 </span> 1484 <span>integer</span> 1485 <span style="display: none; "></span> 1486 </span> 1487 </span> 1488 ) 1489 </div> 1490 1491 </em> 1492 </dt> 1493 <dd class="todo" style="display: none; "> 1494 Undocumented. 1495 </dd> 1496 <dd>The window to restrict the search to. If omitted, returns all views.</dd> 1497 <dd style="display: none; "> 1498 This parameter was added in version 1499 <b><span></span></b>. 1500 You must omit this parameter in earlier versions, 1501 and you may omit it in any version. If you require this 1502 parameter, the manifest key 1503 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1504 can ensure that your extension won't be run in an earlier browser version. 1505 </dd> 1506 1507 <!-- OBJECT PROPERTIES --> 1508 <dd style="display: none; "> 1509 <dl> 1510 <div> 1511 <div> 1512 </div> 1513 </div> 1514 </dl> 1515 </dd> 1516 1517 <!-- FUNCTION PARAMETERS --> 1518 <dd style="display: none; "> 1519 <div></div> 1520 </dd> 1521 1522 </div> 1523 </div> 1524 </dl> 1525 </dd> 1526 1527 <!-- FUNCTION PARAMETERS --> 1528 <dd style="display: none; "> 1529 <div></div> 1530 </dd> 1531 1532 </div> 1533 </div> 1534 </dl> 1535 1536 <!-- RETURNS --> 1537 <h4>Returns</h4> 1538 <dl> 1539 <div> 1540 <div> 1541 <dt> 1542 <var style="display: none; ">paramName</var> 1543 <em> 1544 1545 <!-- TYPE --> 1546 <div style="display:inline"> 1547 ( 1548 <span class="optional" style="display: none; ">optional</span> 1549 <span class="enum" style="display: none; ">enumerated</span> 1550 <span id="typeTemplate"> 1551 <span style="display: none; "> 1552 <a> Type</a> 1553 </span> 1554 <span> 1555 <span> 1556 array of <span><span> 1557 <span style="display: none; "> 1558 <a> Type</a> 1559 </span> 1560 <span> 1561 <span style="display: none; "> 1562 array of <span><span></span></span> 1563 </span> 1564 <span>DOMWindow</span> 1565 <span style="display: none; "></span> 1566 </span> 1567 </span></span> 1568 </span> 1569 <span style="display: none; ">paramType</span> 1570 <span style="display: none; "></span> 1571 </span> 1572 </span> 1573 ) 1574 </div> 1575 1576 </em> 1577 </dt> 1578 <dd class="todo" style="display: none; "> 1579 Undocumented. 1580 </dd> 1581 <dd>Array of global objects</dd> 1582 <dd style="display: none; "> 1583 This parameter was added in version 1584 <b><span></span></b>. 1585 You must omit this parameter in earlier versions, 1586 and you may omit it in any version. If you require this 1587 parameter, the manifest key 1588 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1589 can ensure that your extension won't be run in an earlier browser version. 1590 </dd> 1591 1592 <!-- OBJECT PROPERTIES --> 1593 <dd style="display: none; "> 1594 <dl> 1595 <div> 1596 <div> 1597 </div> 1598 </div> 1599 </dl> 1600 </dd> 1601 1602 <!-- FUNCTION PARAMETERS --> 1603 <dd style="display: none; "> 1604 <div></div> 1605 </dd> 1606 1607 </div> 1608 </div> 1609 </dl> 1610 1611 <!-- CALLBACK --> 1612 <div style="display: none; "> 1613 <div> 1614 <h4>Callback function</h4> 1615 <p> 1616 The callback <em>parameter</em> should specify a function 1617 that looks like this: 1618 </p> 1619 <p> 1620 If you specify the <em>callback</em> parameter, it should 1621 specify a function that looks like this: 1622 </p> 1623 1624 <!-- Note: intentionally longer 80 columns --> 1625 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1626 <dl> 1627 <div> 1628 <div> 1629 </div> 1630 </div> 1631 </dl> 1632 </div> 1633 </div> 1634 1635 <!-- MIN_VERSION --> 1636 <p style="display: none; "> 1637 This function was added in version <b><span></span></b>. 1638 If you require this function, the manifest key 1639 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1640 can ensure that your extension won't be run in an earlier browser version. 1641 </p> 1642 </div> <!-- /description --> 1643 1644 </div><div class="apiItem"> 1645 <a name="method-sendRequest"></a> <!-- method-anchor --> 1646 <h4>sendRequest</h4> 1647 1648 <div class="summary"><span style="display: none; ">void</span> 1649 <!-- Note: intentionally longer 80 columns --> 1650 <span>chrome.extension.sendRequest</span>(<span class="optional"><span style="display: none; ">, </span><span>string</span> 1651 <var><span>extensionId</span></var></span><span class="null"><span>, </span><span>any</span> 1652 <var><span>request</span></var></span><span class="optional"><span>, </span><span>function</span> 1653 <var><span>responseCallback</span></var></span>)</div> 1654 1655 <div class="description"> 1656 <p class="todo" style="display: none; ">Undocumented.</p> 1657 <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.</p> 1658 1659 <!-- PARAMETERS --> 1660 <h4>Parameters</h4> 1661 <dl> 1662 <div> 1663 <div> 1664 <dt> 1665 <var>extensionId</var> 1666 <em> 1667 1668 <!-- TYPE --> 1669 <div style="display:inline"> 1670 ( 1671 <span class="optional">optional</span> 1672 <span class="enum" style="display: none; ">enumerated</span> 1673 <span id="typeTemplate"> 1674 <span style="display: none; "> 1675 <a> Type</a> 1676 </span> 1677 <span> 1678 <span style="display: none; "> 1679 array of <span><span></span></span> 1680 </span> 1681 <span>string</span> 1682 <span style="display: none; "></span> 1683 </span> 1684 </span> 1685 ) 1686 </div> 1687 1688 </em> 1689 </dt> 1690 <dd class="todo" style="display: none; "> 1691 Undocumented. 1692 </dd> 1693 <dd>The extension ID of the extension you want to connect to. If omitted, default is your own extension.</dd> 1694 <dd style="display: none; "> 1695 This parameter was added in version 1696 <b><span></span></b>. 1697 You must omit this parameter in earlier versions, 1698 and you may omit it in any version. If you require this 1699 parameter, the manifest key 1700 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1701 can ensure that your extension won't be run in an earlier browser version. 1702 </dd> 1703 1704 <!-- OBJECT PROPERTIES --> 1705 <dd style="display: none; "> 1706 <dl> 1707 <div> 1708 <div> 1709 </div> 1710 </div> 1711 </dl> 1712 </dd> 1713 1714 <!-- FUNCTION PARAMETERS --> 1715 <dd style="display: none; "> 1716 <div></div> 1717 </dd> 1718 1719 </div> 1720 </div><div> 1721 <div> 1722 <dt> 1723 <var>request</var> 1724 <em> 1725 1726 <!-- TYPE --> 1727 <div style="display:inline"> 1728 ( 1729 <span class="optional" style="display: none; ">optional</span> 1730 <span class="enum" style="display: none; ">enumerated</span> 1731 <span id="typeTemplate"> 1732 <span style="display: none; "> 1733 <a> Type</a> 1734 </span> 1735 <span> 1736 <span style="display: none; "> 1737 array of <span><span></span></span> 1738 </span> 1739 <span>any</span> 1740 <span style="display: none; "></span> 1741 </span> 1742 </span> 1743 ) 1744 </div> 1745 1746 </em> 1747 </dt> 1748 <dd class="todo"> 1749 Undocumented. 1750 </dd> 1751 <dd style="display: none; "> 1752 Description of this parameter from the json schema. 1753 </dd> 1754 <dd style="display: none; "> 1755 This parameter was added in version 1756 <b><span></span></b>. 1757 You must omit this parameter in earlier versions, 1758 and you may omit it in any version. If you require this 1759 parameter, the manifest key 1760 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1761 can ensure that your extension won't be run in an earlier browser version. 1762 </dd> 1763 1764 <!-- OBJECT PROPERTIES --> 1765 <dd style="display: none; "> 1766 <dl> 1767 <div> 1768 <div> 1769 </div> 1770 </div> 1771 </dl> 1772 </dd> 1773 1774 <!-- FUNCTION PARAMETERS --> 1775 <dd style="display: none; "> 1776 <div></div> 1777 </dd> 1778 1779 </div> 1780 </div><div> 1781 <div> 1782 <dt> 1783 <var>responseCallback</var> 1784 <em> 1785 1786 <!-- TYPE --> 1787 <div style="display:inline"> 1788 ( 1789 <span class="optional">optional</span> 1790 <span class="enum" style="display: none; ">enumerated</span> 1791 <span id="typeTemplate"> 1792 <span style="display: none; "> 1793 <a> Type</a> 1794 </span> 1795 <span> 1796 <span style="display: none; "> 1797 array of <span><span></span></span> 1798 </span> 1799 <span>function</span> 1800 <span style="display: none; "></span> 1801 </span> 1802 </span> 1803 ) 1804 </div> 1805 1806 </em> 1807 </dt> 1808 <dd class="todo"> 1809 Undocumented. 1810 </dd> 1811 <dd style="display: none; "> 1812 Description of this parameter from the json schema. 1813 </dd> 1814 <dd style="display: none; "> 1815 This parameter was added in version 1816 <b><span></span></b>. 1817 You must omit this parameter in earlier versions, 1818 and you may omit it in any version. If you require this 1819 parameter, the manifest key 1820 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1821 can ensure that your extension won't be run in an earlier browser version. 1822 </dd> 1823 1824 <!-- OBJECT PROPERTIES --> 1825 <dd style="display: none; "> 1826 <dl> 1827 <div> 1828 <div> 1829 </div> 1830 </div> 1831 </dl> 1832 </dd> 1833 1834 <!-- FUNCTION PARAMETERS --> 1835 <dd> 1836 <div> 1837 <h5>Parameters</h5> 1838 <dl> 1839 <div> 1840 <div> 1841 <dt> 1842 <var>response</var> 1843 <em> 1844 1845 <!-- TYPE --> 1846 <div style="display:inline"> 1847 ( 1848 <span class="optional" style="display: none; ">optional</span> 1849 <span class="enum" style="display: none; ">enumerated</span> 1850 <span id="typeTemplate"> 1851 <span style="display: none; "> 1852 <a> Type</a> 1853 </span> 1854 <span> 1855 <span style="display: none; "> 1856 array of <span><span></span></span> 1857 </span> 1858 <span>any</span> 1859 <span style="display: none; "></span> 1860 </span> 1861 </span> 1862 ) 1863 </div> 1864 1865 </em> 1866 </dt> 1867 <dd class="todo" style="display: none; "> 1868 Undocumented. 1869 </dd> 1870 <dd>The JSON response object sent by the handler of the request.</dd> 1871 <dd style="display: none; "> 1872 This parameter was added in version 1873 <b><span></span></b>. 1874 You must omit this parameter in earlier versions, 1875 and you may omit it in any version. If you require this 1876 parameter, the manifest key 1877 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1878 can ensure that your extension won't be run in an earlier browser version. 1879 </dd> 1880 1881 <!-- OBJECT PROPERTIES --> 1882 <dd style="display: none; "> 1883 <dl> 1884 <div> 1885 <div> 1886 </div> 1887 </div> 1888 </dl> 1889 </dd> 1890 1891 <!-- FUNCTION PARAMETERS --> 1892 <dd style="display: none; "> 1893 <div></div> 1894 </dd> 1895 1896 </div> 1897 </div> 1898 </dl> 1899 </div> 1900 </dd> 1901 1902 </div> 1903 </div> 1904 </dl> 1905 1906 <!-- RETURNS --> 1907 <h4 style="display: none; ">Returns</h4> 1908 <dl> 1909 <div style="display: none; "> 1910 <div> 1911 </div> 1912 </div> 1913 </dl> 1914 1915 <!-- CALLBACK --> 1916 <div> 1917 <div> 1918 <h4>Callback function</h4> 1919 <p style="display: none; "> 1920 The callback <em>parameter</em> should specify a function 1921 that looks like this: 1922 </p> 1923 <p> 1924 If you specify the <em>callback</em> parameter, it should 1925 specify a function that looks like this: 1926 </p> 1927 1928 <!-- Note: intentionally longer 80 columns --> 1929 <pre>function(<span>any response</span>) <span class="subdued">{...}</span>;</pre> 1930 <dl> 1931 <div> 1932 <div> 1933 <dt> 1934 <var>response</var> 1935 <em> 1936 1937 <!-- TYPE --> 1938 <div style="display:inline"> 1939 ( 1940 <span class="optional" style="display: none; ">optional</span> 1941 <span class="enum" style="display: none; ">enumerated</span> 1942 <span id="typeTemplate"> 1943 <span style="display: none; "> 1944 <a> Type</a> 1945 </span> 1946 <span> 1947 <span style="display: none; "> 1948 array of <span><span></span></span> 1949 </span> 1950 <span>any</span> 1951 <span style="display: none; "></span> 1952 </span> 1953 </span> 1954 ) 1955 </div> 1956 1957 </em> 1958 </dt> 1959 <dd class="todo" style="display: none; "> 1960 Undocumented. 1961 </dd> 1962 <dd>The JSON response object sent by the handler of the request.</dd> 1963 <dd style="display: none; "> 1964 This parameter was added in version 1965 <b><span></span></b>. 1966 You must omit this parameter in earlier versions, 1967 and you may omit it in any version. If you require this 1968 parameter, the manifest key 1969 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1970 can ensure that your extension won't be run in an earlier browser version. 1971 </dd> 1972 1973 <!-- OBJECT PROPERTIES --> 1974 <dd style="display: none; "> 1975 <dl> 1976 <div> 1977 <div> 1978 </div> 1979 </div> 1980 </dl> 1981 </dd> 1982 1983 <!-- FUNCTION PARAMETERS --> 1984 <dd style="display: none; "> 1985 <div></div> 1986 </dd> 1987 1988 </div> 1989 </div> 1990 </dl> 1991 </div> 1992 </div> 1993 1994 <!-- MIN_VERSION --> 1995 <p style="display: none; "> 1996 This function was added in version <b><span></span></b>. 1997 If you require this function, the manifest key 1998 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1999 can ensure that your extension won't be run in an earlier browser version. 2000 </p> 2001 </div> <!-- /description --> 2002 2003 </div> <!-- /apiItem --> 2004 2005 </div> <!-- /apiGroup --> 2006 2007 <!-- EVENTS --> 2008 <div class="apiGroup"> 2009 <a name="events"></a> 2010 <h3 id="events">Events</h3> 2011 2012 <!-- iterates over all events --> 2013 <div class="apiItem"> 2014 <a name="event-onConnect"></a> 2015 <h4>onConnect</h4> 2016 2017 <div class="summary"> 2018 <!-- Note: intentionally longer 80 columns --> 2019 <span class="subdued">chrome.extension.</span><span>onConnect</span><span class="subdued">.addListener</span>(function(<span>Port port</span>) <span class="subdued">{...}</span>); 2020 </div> 2021 2022 <div class="description"> 2023 <p class="todo" style="display: none; ">Undocumented.</p> 2024 <p>Fired when a connection is made from either an extension process or a content script.</p> 2025 2026 <!-- PARAMETERS --> 2027 <h4>Parameters</h4> 2028 <dl> 2029 <div> 2030 <div> 2031 <dt> 2032 <var>port</var> 2033 <em> 2034 2035 <!-- TYPE --> 2036 <div style="display:inline"> 2037 ( 2038 <span class="optional" style="display: none; ">optional</span> 2039 <span class="enum" style="display: none; ">enumerated</span> 2040 <span id="typeTemplate"> 2041 <span> 2042 <a href="extension.html#type-Port">Port</a> 2043 </span> 2044 <span style="display: none; "> 2045 <span> 2046 array of <span><span></span></span> 2047 </span> 2048 <span>paramType</span> 2049 <span></span> 2050 </span> 2051 </span> 2052 ) 2053 </div> 2054 2055 </em> 2056 </dt> 2057 <dd class="todo"> 2058 Undocumented. 2059 </dd> 2060 <dd style="display: none; "> 2061 Description of this parameter from the json schema. 2062 </dd> 2063 <dd style="display: none; "> 2064 This parameter was added in version 2065 <b><span></span></b>. 2066 You must omit this parameter in earlier versions, 2067 and you may omit it in any version. If you require this 2068 parameter, the manifest key 2069 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2070 can ensure that your extension won't be run in an earlier browser version. 2071 </dd> 2072 2073 <!-- OBJECT PROPERTIES --> 2074 <dd style="display: none; "> 2075 <dl> 2076 <div> 2077 <div> 2078 </div> 2079 </div> 2080 </dl> 2081 </dd> 2082 2083 <!-- FUNCTION PARAMETERS --> 2084 <dd style="display: none; "> 2085 <div></div> 2086 </dd> 2087 2088 </div> 2089 </div> 2090 </dl> 2091 2092 </div> <!-- /decription --> 2093 2094 </div><div class="apiItem"> 2095 <a name="event-onConnectExternal"></a> 2096 <h4>onConnectExternal</h4> 2097 2098 <div class="summary"> 2099 <!-- Note: intentionally longer 80 columns --> 2100 <span class="subdued">chrome.extension.</span><span>onConnectExternal</span><span class="subdued">.addListener</span>(function(<span>Port port</span>) <span class="subdued">{...}</span>); 2101 </div> 2102 2103 <div class="description"> 2104 <p class="todo" style="display: none; ">Undocumented.</p> 2105 <p>Fired when a connection is made from another extension.</p> 2106 2107 <!-- PARAMETERS --> 2108 <h4>Parameters</h4> 2109 <dl> 2110 <div> 2111 <div> 2112 <dt> 2113 <var>port</var> 2114 <em> 2115 2116 <!-- TYPE --> 2117 <div style="display:inline"> 2118 ( 2119 <span class="optional" style="display: none; ">optional</span> 2120 <span class="enum" style="display: none; ">enumerated</span> 2121 <span id="typeTemplate"> 2122 <span> 2123 <a href="extension.html#type-Port">Port</a> 2124 </span> 2125 <span style="display: none; "> 2126 <span> 2127 array of <span><span></span></span> 2128 </span> 2129 <span>paramType</span> 2130 <span></span> 2131 </span> 2132 </span> 2133 ) 2134 </div> 2135 2136 </em> 2137 </dt> 2138 <dd class="todo"> 2139 Undocumented. 2140 </dd> 2141 <dd style="display: none; "> 2142 Description of this parameter from the json schema. 2143 </dd> 2144 <dd style="display: none; "> 2145 This parameter was added in version 2146 <b><span></span></b>. 2147 You must omit this parameter in earlier versions, 2148 and you may omit it in any version. If you require this 2149 parameter, the manifest key 2150 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2151 can ensure that your extension won't be run in an earlier browser version. 2152 </dd> 2153 2154 <!-- OBJECT PROPERTIES --> 2155 <dd style="display: none; "> 2156 <dl> 2157 <div> 2158 <div> 2159 </div> 2160 </div> 2161 </dl> 2162 </dd> 2163 2164 <!-- FUNCTION PARAMETERS --> 2165 <dd style="display: none; "> 2166 <div></div> 2167 </dd> 2168 2169 </div> 2170 </div> 2171 </dl> 2172 2173 </div> <!-- /decription --> 2174 2175 </div><div class="apiItem"> 2176 <a name="event-onRequest"></a> 2177 <h4>onRequest</h4> 2178 2179 <div class="summary"> 2180 <!-- Note: intentionally longer 80 columns --> 2181 <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>); 2182 </div> 2183 2184 <div class="description"> 2185 <p class="todo" style="display: none; ">Undocumented.</p> 2186 <p>Fired when a request is sent from either an extension process or a content script.</p> 2187 2188 <!-- PARAMETERS --> 2189 <h4>Parameters</h4> 2190 <dl> 2191 <div> 2192 <div> 2193 <dt> 2194 <var>request</var> 2195 <em> 2196 2197 <!-- TYPE --> 2198 <div style="display:inline"> 2199 ( 2200 <span class="optional" style="display: none; ">optional</span> 2201 <span class="enum" style="display: none; ">enumerated</span> 2202 <span id="typeTemplate"> 2203 <span style="display: none; "> 2204 <a> Type</a> 2205 </span> 2206 <span> 2207 <span style="display: none; "> 2208 array of <span><span></span></span> 2209 </span> 2210 <span>any</span> 2211 <span style="display: none; "></span> 2212 </span> 2213 </span> 2214 ) 2215 </div> 2216 2217 </em> 2218 </dt> 2219 <dd class="todo" style="display: none; "> 2220 Undocumented. 2221 </dd> 2222 <dd>The request sent by the calling script.</dd> 2223 <dd style="display: none; "> 2224 This parameter was added in version 2225 <b><span></span></b>. 2226 You must omit this parameter in earlier versions, 2227 and you may omit it in any version. If you require this 2228 parameter, the manifest key 2229 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2230 can ensure that your extension won't be run in an earlier browser version. 2231 </dd> 2232 2233 <!-- OBJECT PROPERTIES --> 2234 <dd style="display: none; "> 2235 <dl> 2236 <div> 2237 <div> 2238 </div> 2239 </div> 2240 </dl> 2241 </dd> 2242 2243 <!-- FUNCTION PARAMETERS --> 2244 <dd style="display: none; "> 2245 <div></div> 2246 </dd> 2247 2248 </div> 2249 </div><div> 2250 <div> 2251 <dt> 2252 <var>sender</var> 2253 <em> 2254 2255 <!-- TYPE --> 2256 <div style="display:inline"> 2257 ( 2258 <span class="optional" style="display: none; ">optional</span> 2259 <span class="enum" style="display: none; ">enumerated</span> 2260 <span id="typeTemplate"> 2261 <span> 2262 <a href="extension.html#type-MessageSender">MessageSender</a> 2263 </span> 2264 <span style="display: none; "> 2265 <span> 2266 array of <span><span></span></span> 2267 </span> 2268 <span>paramType</span> 2269 <span></span> 2270 </span> 2271 </span> 2272 ) 2273 </div> 2274 2275 </em> 2276 </dt> 2277 <dd class="todo"> 2278 Undocumented. 2279 </dd> 2280 <dd style="display: none; "> 2281 Description of this parameter from the json schema. 2282 </dd> 2283 <dd style="display: none; "> 2284 This parameter was added in version 2285 <b><span></span></b>. 2286 You must omit this parameter in earlier versions, 2287 and you may omit it in any version. If you require this 2288 parameter, the manifest key 2289 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2290 can ensure that your extension won't be run in an earlier browser version. 2291 </dd> 2292 2293 <!-- OBJECT PROPERTIES --> 2294 <dd style="display: none; "> 2295 <dl> 2296 <div> 2297 <div> 2298 </div> 2299 </div> 2300 </dl> 2301 </dd> 2302 2303 <!-- FUNCTION PARAMETERS --> 2304 <dd style="display: none; "> 2305 <div></div> 2306 </dd> 2307 2308 </div> 2309 </div><div> 2310 <div> 2311 <dt> 2312 <var>sendResponse</var> 2313 <em> 2314 2315 <!-- TYPE --> 2316 <div style="display:inline"> 2317 ( 2318 <span class="optional" style="display: none; ">optional</span> 2319 <span class="enum" style="display: none; ">enumerated</span> 2320 <span id="typeTemplate"> 2321 <span style="display: none; "> 2322 <a> Type</a> 2323 </span> 2324 <span> 2325 <span style="display: none; "> 2326 array of <span><span></span></span> 2327 </span> 2328 <span>function</span> 2329 <span style="display: none; "></span> 2330 </span> 2331 </span> 2332 ) 2333 </div> 2334 2335 </em> 2336 </dt> 2337 <dd class="todo" style="display: none; "> 2338 Undocumented. 2339 </dd> 2340 <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> 2341 <dd style="display: none; "> 2342 This parameter was added in version 2343 <b><span></span></b>. 2344 You must omit this parameter in earlier versions, 2345 and you may omit it in any version. If you require this 2346 parameter, the manifest key 2347 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2348 can ensure that your extension won't be run in an earlier browser version. 2349 </dd> 2350 2351 <!-- OBJECT PROPERTIES --> 2352 <dd style="display: none; "> 2353 <dl> 2354 <div> 2355 <div> 2356 </div> 2357 </div> 2358 </dl> 2359 </dd> 2360 2361 <!-- FUNCTION PARAMETERS --> 2362 <dd style="display: none; "> 2363 <div></div> 2364 </dd> 2365 2366 </div> 2367 </div> 2368 </dl> 2369 2370 </div> <!-- /decription --> 2371 2372 </div><div class="apiItem"> 2373 <a name="event-onRequestExternal"></a> 2374 <h4>onRequestExternal</h4> 2375 2376 <div class="summary"> 2377 <!-- Note: intentionally longer 80 columns --> 2378 <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>); 2379 </div> 2380 2381 <div class="description"> 2382 <p class="todo" style="display: none; ">Undocumented.</p> 2383 <p>Fired when a request is sent from another extension.</p> 2384 2385 <!-- PARAMETERS --> 2386 <h4>Parameters</h4> 2387 <dl> 2388 <div> 2389 <div> 2390 <dt> 2391 <var>request</var> 2392 <em> 2393 2394 <!-- TYPE --> 2395 <div style="display:inline"> 2396 ( 2397 <span class="optional" style="display: none; ">optional</span> 2398 <span class="enum" style="display: none; ">enumerated</span> 2399 <span id="typeTemplate"> 2400 <span style="display: none; "> 2401 <a> Type</a> 2402 </span> 2403 <span> 2404 <span style="display: none; "> 2405 array of <span><span></span></span> 2406 </span> 2407 <span>any</span> 2408 <span style="display: none; "></span> 2409 </span> 2410 </span> 2411 ) 2412 </div> 2413 2414 </em> 2415 </dt> 2416 <dd class="todo" style="display: none; "> 2417 Undocumented. 2418 </dd> 2419 <dd>The request sent by the calling script.</dd> 2420 <dd style="display: none; "> 2421 This parameter was added in version 2422 <b><span></span></b>. 2423 You must omit this parameter in earlier versions, 2424 and you may omit it in any version. If you require this 2425 parameter, the manifest key 2426 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2427 can ensure that your extension won't be run in an earlier browser version. 2428 </dd> 2429 2430 <!-- OBJECT PROPERTIES --> 2431 <dd style="display: none; "> 2432 <dl> 2433 <div> 2434 <div> 2435 </div> 2436 </div> 2437 </dl> 2438 </dd> 2439 2440 <!-- FUNCTION PARAMETERS --> 2441 <dd style="display: none; "> 2442 <div></div> 2443 </dd> 2444 2445 </div> 2446 </div><div> 2447 <div> 2448 <dt> 2449 <var>sender</var> 2450 <em> 2451 2452 <!-- TYPE --> 2453 <div style="display:inline"> 2454 ( 2455 <span class="optional" style="display: none; ">optional</span> 2456 <span class="enum" style="display: none; ">enumerated</span> 2457 <span id="typeTemplate"> 2458 <span> 2459 <a href="extension.html#type-MessageSender">MessageSender</a> 2460 </span> 2461 <span style="display: none; "> 2462 <span> 2463 array of <span><span></span></span> 2464 </span> 2465 <span>paramType</span> 2466 <span></span> 2467 </span> 2468 </span> 2469 ) 2470 </div> 2471 2472 </em> 2473 </dt> 2474 <dd class="todo"> 2475 Undocumented. 2476 </dd> 2477 <dd style="display: none; "> 2478 Description of this parameter from the json schema. 2479 </dd> 2480 <dd style="display: none; "> 2481 This parameter was added in version 2482 <b><span></span></b>. 2483 You must omit this parameter in earlier versions, 2484 and you may omit it in any version. If you require this 2485 parameter, the manifest key 2486 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2487 can ensure that your extension won't be run in an earlier browser version. 2488 </dd> 2489 2490 <!-- OBJECT PROPERTIES --> 2491 <dd style="display: none; "> 2492 <dl> 2493 <div> 2494 <div> 2495 </div> 2496 </div> 2497 </dl> 2498 </dd> 2499 2500 <!-- FUNCTION PARAMETERS --> 2501 <dd style="display: none; "> 2502 <div></div> 2503 </dd> 2504 2505 </div> 2506 </div><div> 2507 <div> 2508 <dt> 2509 <var>sendResponse</var> 2510 <em> 2511 2512 <!-- TYPE --> 2513 <div style="display:inline"> 2514 ( 2515 <span class="optional" style="display: none; ">optional</span> 2516 <span class="enum" style="display: none; ">enumerated</span> 2517 <span id="typeTemplate"> 2518 <span style="display: none; "> 2519 <a> Type</a> 2520 </span> 2521 <span> 2522 <span style="display: none; "> 2523 array of <span><span></span></span> 2524 </span> 2525 <span>function</span> 2526 <span style="display: none; "></span> 2527 </span> 2528 </span> 2529 ) 2530 </div> 2531 2532 </em> 2533 </dt> 2534 <dd class="todo" style="display: none; "> 2535 Undocumented. 2536 </dd> 2537 <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> 2538 <dd style="display: none; "> 2539 This parameter was added in version 2540 <b><span></span></b>. 2541 You must omit this parameter in earlier versions, 2542 and you may omit it in any version. If you require this 2543 parameter, the manifest key 2544 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2545 can ensure that your extension won't be run in an earlier browser version. 2546 </dd> 2547 2548 <!-- OBJECT PROPERTIES --> 2549 <dd style="display: none; "> 2550 <dl> 2551 <div> 2552 <div> 2553 </div> 2554 </div> 2555 </dl> 2556 </dd> 2557 2558 <!-- FUNCTION PARAMETERS --> 2559 <dd style="display: none; "> 2560 <div></div> 2561 </dd> 2562 2563 </div> 2564 </div> 2565 </dl> 2566 2567 </div> <!-- /decription --> 2568 2569 </div> <!-- /apiItem --> 2570 2571 </div> <!-- /apiGroup --> 2572 2573 <!-- TYPES --> 2574 <div class="apiGroup"> 2575 <a name="types"></a> 2576 <h3 id="types">Types</h3> 2577 2578 <!-- iterates over all types --> 2579 <div class="apiItem"> 2580 <a name="type-MessageSender"></a> 2581 <h4>MessageSender</h4> 2582 2583 <div> 2584 <dt> 2585 <var style="display: none; ">paramName</var> 2586 <em> 2587 2588 <!-- TYPE --> 2589 <div style="display:inline"> 2590 ( 2591 <span class="optional" style="display: none; ">optional</span> 2592 <span class="enum" style="display: none; ">enumerated</span> 2593 <span id="typeTemplate"> 2594 <span style="display: none; "> 2595 <a> Type</a> 2596 </span> 2597 <span> 2598 <span style="display: none; "> 2599 array of <span><span></span></span> 2600 </span> 2601 <span>object</span> 2602 <span style="display: none; "></span> 2603 </span> 2604 </span> 2605 ) 2606 </div> 2607 2608 </em> 2609 </dt> 2610 <dd class="todo" style="display: none; "> 2611 Undocumented. 2612 </dd> 2613 <dd>An object containing information about the script context that sent a message or request.</dd> 2614 <dd style="display: none; "> 2615 This parameter was added in version 2616 <b><span></span></b>. 2617 You must omit this parameter in earlier versions, 2618 and you may omit it in any version. If you require this 2619 parameter, the manifest key 2620 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2621 can ensure that your extension won't be run in an earlier browser version. 2622 </dd> 2623 2624 <!-- OBJECT PROPERTIES --> 2625 <dd> 2626 <dl> 2627 <div> 2628 <div> 2629 <dt> 2630 <var>tab</var> 2631 <em> 2632 2633 <!-- TYPE --> 2634 <div style="display:inline"> 2635 ( 2636 <span class="optional">optional</span> 2637 <span class="enum" style="display: none; ">enumerated</span> 2638 <span id="typeTemplate"> 2639 <span> 2640 <a href="tabs.html#type-Tab">Tab</a> 2641 </span> 2642 <span style="display: none; "> 2643 <span> 2644 array of <span><span></span></span> 2645 </span> 2646 <span>paramType</span> 2647 <span></span> 2648 </span> 2649 </span> 2650 ) 2651 </div> 2652 2653 </em> 2654 </dt> 2655 <dd class="todo" style="display: none; "> 2656 Undocumented. 2657 </dd> 2658 <dd>This property will <b>only</b> be present when the connection was opened from a tab or content script.</dd> 2659 <dd style="display: none; "> 2660 This parameter was added in version 2661 <b><span></span></b>. 2662 You must omit this parameter in earlier versions, 2663 and you may omit it in any version. If you require this 2664 parameter, the manifest key 2665 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2666 can ensure that your extension won't be run in an earlier browser version. 2667 </dd> 2668 2669 <!-- OBJECT PROPERTIES --> 2670 <dd style="display: none; "> 2671 <dl> 2672 <div> 2673 <div> 2674 </div> 2675 </div> 2676 </dl> 2677 </dd> 2678 2679 <!-- FUNCTION PARAMETERS --> 2680 <dd style="display: none; "> 2681 <div></div> 2682 </dd> 2683 2684 </div> 2685 </div><div> 2686 <div> 2687 <dt> 2688 <var>id</var> 2689 <em> 2690 2691 <!-- TYPE --> 2692 <div style="display:inline"> 2693 ( 2694 <span class="optional" style="display: none; ">optional</span> 2695 <span class="enum" style="display: none; ">enumerated</span> 2696 <span id="typeTemplate"> 2697 <span style="display: none; "> 2698 <a> Type</a> 2699 </span> 2700 <span> 2701 <span style="display: none; "> 2702 array of <span><span></span></span> 2703 </span> 2704 <span>string</span> 2705 <span style="display: none; "></span> 2706 </span> 2707 </span> 2708 ) 2709 </div> 2710 2711 </em> 2712 </dt> 2713 <dd class="todo" style="display: none; "> 2714 Undocumented. 2715 </dd> 2716 <dd>The extension ID of the extension that opened the connection.</dd> 2717 <dd style="display: none; "> 2718 This parameter was added in version 2719 <b><span></span></b>. 2720 You must omit this parameter in earlier versions, 2721 and you may omit it in any version. If you require this 2722 parameter, the manifest key 2723 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2724 can ensure that your extension won't be run in an earlier browser version. 2725 </dd> 2726 2727 <!-- OBJECT PROPERTIES --> 2728 <dd style="display: none; "> 2729 <dl> 2730 <div> 2731 <div> 2732 </div> 2733 </div> 2734 </dl> 2735 </dd> 2736 2737 <!-- FUNCTION PARAMETERS --> 2738 <dd style="display: none; "> 2739 <div></div> 2740 </dd> 2741 2742 </div> 2743 </div> 2744 </dl> 2745 </dd> 2746 2747 <!-- FUNCTION PARAMETERS --> 2748 <dd style="display: none; "> 2749 <div></div> 2750 </dd> 2751 2752 </div> 2753 2754 </div><div class="apiItem"> 2755 <a name="type-Event"></a> 2756 <h4>Event</h4> 2757 2758 <div> 2759 <dt> 2760 <var style="display: none; ">paramName</var> 2761 <em> 2762 2763 <!-- TYPE --> 2764 <div style="display:inline"> 2765 ( 2766 <span class="optional" style="display: none; ">optional</span> 2767 <span class="enum" style="display: none; ">enumerated</span> 2768 <span id="typeTemplate"> 2769 <span style="display: none; "> 2770 <a> Type</a> 2771 </span> 2772 <span> 2773 <span style="display: none; "> 2774 array of <span><span></span></span> 2775 </span> 2776 <span>object</span> 2777 <span style="display: none; "></span> 2778 </span> 2779 </span> 2780 ) 2781 </div> 2782 2783 </em> 2784 </dt> 2785 <dd class="todo" style="display: none; "> 2786 Undocumented. 2787 </dd> 2788 <dd>An object which allows the addition and removal of listeners for a Chrome event.</dd> 2789 <dd style="display: none; "> 2790 This parameter was added in version 2791 <b><span></span></b>. 2792 You must omit this parameter in earlier versions, 2793 and you may omit it in any version. If you require this 2794 parameter, the manifest key 2795 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2796 can ensure that your extension won't be run in an earlier browser version. 2797 </dd> 2798 2799 <!-- OBJECT PROPERTIES --> 2800 <dd> 2801 <dl> 2802 <div> 2803 <div> 2804 <dt> 2805 <var>addListener</var> 2806 <em> 2807 2808 <!-- TYPE --> 2809 <div style="display:inline"> 2810 ( 2811 <span class="optional" style="display: none; ">optional</span> 2812 <span class="enum" style="display: none; ">enumerated</span> 2813 <span id="typeTemplate"> 2814 <span style="display: none; "> 2815 <a> Type</a> 2816 </span> 2817 <span> 2818 <span style="display: none; "> 2819 array of <span><span></span></span> 2820 </span> 2821 <span>function</span> 2822 <span style="display: none; "></span> 2823 </span> 2824 </span> 2825 ) 2826 </div> 2827 2828 </em> 2829 </dt> 2830 <dd class="todo"> 2831 Undocumented. 2832 </dd> 2833 <dd style="display: none; "> 2834 Description of this parameter from the json schema. 2835 </dd> 2836 <dd style="display: none; "> 2837 This parameter was added in version 2838 <b><span></span></b>. 2839 You must omit this parameter in earlier versions, 2840 and you may omit it in any version. If you require this 2841 parameter, the manifest key 2842 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2843 can ensure that your extension won't be run in an earlier browser version. 2844 </dd> 2845 2846 <!-- OBJECT PROPERTIES --> 2847 <dd style="display: none; "> 2848 <dl> 2849 <div> 2850 <div> 2851 </div> 2852 </div> 2853 </dl> 2854 </dd> 2855 2856 <!-- FUNCTION PARAMETERS --> 2857 <dd style="display: none; "> 2858 <div></div> 2859 </dd> 2860 2861 </div> 2862 </div><div> 2863 <div> 2864 <dt> 2865 <var>removeListener</var> 2866 <em> 2867 2868 <!-- TYPE --> 2869 <div style="display:inline"> 2870 ( 2871 <span class="optional" style="display: none; ">optional</span> 2872 <span class="enum" style="display: none; ">enumerated</span> 2873 <span id="typeTemplate"> 2874 <span style="display: none; "> 2875 <a> Type</a> 2876 </span> 2877 <span> 2878 <span style="display: none; "> 2879 array of <span><span></span></span> 2880 </span> 2881 <span>function</span> 2882 <span style="display: none; "></span> 2883 </span> 2884 </span> 2885 ) 2886 </div> 2887 2888 </em> 2889 </dt> 2890 <dd class="todo"> 2891 Undocumented. 2892 </dd> 2893 <dd style="display: none; "> 2894 Description of this parameter from the json schema. 2895 </dd> 2896 <dd style="display: none; "> 2897 This parameter was added in version 2898 <b><span></span></b>. 2899 You must omit this parameter in earlier versions, 2900 and you may omit it in any version. If you require this 2901 parameter, the manifest key 2902 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2903 can ensure that your extension won't be run in an earlier browser version. 2904 </dd> 2905 2906 <!-- OBJECT PROPERTIES --> 2907 <dd style="display: none; "> 2908 <dl> 2909 <div> 2910 <div> 2911 </div> 2912 </div> 2913 </dl> 2914 </dd> 2915 2916 <!-- FUNCTION PARAMETERS --> 2917 <dd style="display: none; "> 2918 <div></div> 2919 </dd> 2920 2921 </div> 2922 </div><div> 2923 <div> 2924 <dt> 2925 <var>hasListener</var> 2926 <em> 2927 2928 <!-- TYPE --> 2929 <div style="display:inline"> 2930 ( 2931 <span class="optional" style="display: none; ">optional</span> 2932 <span class="enum" style="display: none; ">enumerated</span> 2933 <span id="typeTemplate"> 2934 <span style="display: none; "> 2935 <a> Type</a> 2936 </span> 2937 <span> 2938 <span style="display: none; "> 2939 array of <span><span></span></span> 2940 </span> 2941 <span>function</span> 2942 <span style="display: none; "></span> 2943 </span> 2944 </span> 2945 ) 2946 </div> 2947 2948 </em> 2949 </dt> 2950 <dd class="todo"> 2951 Undocumented. 2952 </dd> 2953 <dd style="display: none; "> 2954 Description of this parameter from the json schema. 2955 </dd> 2956 <dd style="display: none; "> 2957 This parameter was added in version 2958 <b><span></span></b>. 2959 You must omit this parameter in earlier versions, 2960 and you may omit it in any version. If you require this 2961 parameter, the manifest key 2962 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2963 can ensure that your extension won't be run in an earlier browser version. 2964 </dd> 2965 2966 <!-- OBJECT PROPERTIES --> 2967 <dd style="display: none; "> 2968 <dl> 2969 <div> 2970 <div> 2971 </div> 2972 </div> 2973 </dl> 2974 </dd> 2975 2976 <!-- FUNCTION PARAMETERS --> 2977 <dd style="display: none; "> 2978 <div></div> 2979 </dd> 2980 2981 </div> 2982 </div><div> 2983 <div> 2984 <dt> 2985 <var>hasListeners</var> 2986 <em> 2987 2988 <!-- TYPE --> 2989 <div style="display:inline"> 2990 ( 2991 <span class="optional" style="display: none; ">optional</span> 2992 <span class="enum" style="display: none; ">enumerated</span> 2993 <span id="typeTemplate"> 2994 <span style="display: none; "> 2995 <a> Type</a> 2996 </span> 2997 <span> 2998 <span style="display: none; "> 2999 array of <span><span></span></span> 3000 </span> 3001 <span>function</span> 3002 <span style="display: none; "></span> 3003 </span> 3004 </span> 3005 ) 3006 </div> 3007 3008 </em> 3009 </dt> 3010 <dd class="todo"> 3011 Undocumented. 3012 </dd> 3013 <dd style="display: none; "> 3014 Description of this parameter from the json schema. 3015 </dd> 3016 <dd style="display: none; "> 3017 This parameter was added in version 3018 <b><span></span></b>. 3019 You must omit this parameter in earlier versions, 3020 and you may omit it in any version. If you require this 3021 parameter, the manifest key 3022 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3023 can ensure that your extension won't be run in an earlier browser version. 3024 </dd> 3025 3026 <!-- OBJECT PROPERTIES --> 3027 <dd style="display: none; "> 3028 <dl> 3029 <div> 3030 <div> 3031 </div> 3032 </div> 3033 </dl> 3034 </dd> 3035 3036 <!-- FUNCTION PARAMETERS --> 3037 <dd style="display: none; "> 3038 <div></div> 3039 </dd> 3040 3041 </div> 3042 </div> 3043 </dl> 3044 </dd> 3045 3046 <!-- FUNCTION PARAMETERS --> 3047 <dd style="display: none; "> 3048 <div></div> 3049 </dd> 3050 3051 </div> 3052 3053 </div><div class="apiItem"> 3054 <a name="type-Port"></a> 3055 <h4>Port</h4> 3056 3057 <div> 3058 <dt> 3059 <var style="display: none; ">paramName</var> 3060 <em> 3061 3062 <!-- TYPE --> 3063 <div style="display:inline"> 3064 ( 3065 <span class="optional" style="display: none; ">optional</span> 3066 <span class="enum" style="display: none; ">enumerated</span> 3067 <span id="typeTemplate"> 3068 <span style="display: none; "> 3069 <a> Type</a> 3070 </span> 3071 <span> 3072 <span style="display: none; "> 3073 array of <span><span></span></span> 3074 </span> 3075 <span>object</span> 3076 <span style="display: none; "></span> 3077 </span> 3078 </span> 3079 ) 3080 </div> 3081 3082 </em> 3083 </dt> 3084 <dd class="todo" style="display: none; "> 3085 Undocumented. 3086 </dd> 3087 <dd>An object which allows two way communication with other pages.</dd> 3088 <dd style="display: none; "> 3089 This parameter was added in version 3090 <b><span></span></b>. 3091 You must omit this parameter in earlier versions, 3092 and you may omit it in any version. If you require this 3093 parameter, the manifest key 3094 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3095 can ensure that your extension won't be run in an earlier browser version. 3096 </dd> 3097 3098 <!-- OBJECT PROPERTIES --> 3099 <dd> 3100 <dl> 3101 <div> 3102 <div> 3103 <dt> 3104 <var>name</var> 3105 <em> 3106 3107 <!-- TYPE --> 3108 <div style="display:inline"> 3109 ( 3110 <span class="optional" style="display: none; ">optional</span> 3111 <span class="enum" style="display: none; ">enumerated</span> 3112 <span id="typeTemplate"> 3113 <span style="display: none; "> 3114 <a> Type</a> 3115 </span> 3116 <span> 3117 <span style="display: none; "> 3118 array of <span><span></span></span> 3119 </span> 3120 <span>string</span> 3121 <span style="display: none; "></span> 3122 </span> 3123 </span> 3124 ) 3125 </div> 3126 3127 </em> 3128 </dt> 3129 <dd class="todo"> 3130 Undocumented. 3131 </dd> 3132 <dd style="display: none; "> 3133 Description of this parameter from the json schema. 3134 </dd> 3135 <dd style="display: none; "> 3136 This parameter was added in version 3137 <b><span></span></b>. 3138 You must omit this parameter in earlier versions, 3139 and you may omit it in any version. If you require this 3140 parameter, the manifest key 3141 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3142 can ensure that your extension won't be run in an earlier browser version. 3143 </dd> 3144 3145 <!-- OBJECT PROPERTIES --> 3146 <dd style="display: none; "> 3147 <dl> 3148 <div> 3149 <div> 3150 </div> 3151 </div> 3152 </dl> 3153 </dd> 3154 3155 <!-- FUNCTION PARAMETERS --> 3156 <dd style="display: none; "> 3157 <div></div> 3158 </dd> 3159 3160 </div> 3161 </div><div> 3162 <div> 3163 <dt> 3164 <var>onDisconnect</var> 3165 <em> 3166 3167 <!-- TYPE --> 3168 <div style="display:inline"> 3169 ( 3170 <span class="optional" style="display: none; ">optional</span> 3171 <span class="enum" style="display: none; ">enumerated</span> 3172 <span id="typeTemplate"> 3173 <span> 3174 <a href="extension.html#type-Event">Event</a> 3175 </span> 3176 <span style="display: none; "> 3177 <span> 3178 array of <span><span></span></span> 3179 </span> 3180 <span>paramType</span> 3181 <span></span> 3182 </span> 3183 </span> 3184 ) 3185 </div> 3186 3187 </em> 3188 </dt> 3189 <dd class="todo"> 3190 Undocumented. 3191 </dd> 3192 <dd style="display: none; "> 3193 Description of this parameter from the json schema. 3194 </dd> 3195 <dd style="display: none; "> 3196 This parameter was added in version 3197 <b><span></span></b>. 3198 You must omit this parameter in earlier versions, 3199 and you may omit it in any version. If you require this 3200 parameter, the manifest key 3201 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3202 can ensure that your extension won't be run in an earlier browser version. 3203 </dd> 3204 3205 <!-- OBJECT PROPERTIES --> 3206 <dd style="display: none; "> 3207 <dl> 3208 <div> 3209 <div> 3210 </div> 3211 </div> 3212 </dl> 3213 </dd> 3214 3215 <!-- FUNCTION PARAMETERS --> 3216 <dd style="display: none; "> 3217 <div></div> 3218 </dd> 3219 3220 </div> 3221 </div><div> 3222 <div> 3223 <dt> 3224 <var>onMessage</var> 3225 <em> 3226 3227 <!-- TYPE --> 3228 <div style="display:inline"> 3229 ( 3230 <span class="optional" style="display: none; ">optional</span> 3231 <span class="enum" style="display: none; ">enumerated</span> 3232 <span id="typeTemplate"> 3233 <span> 3234 <a href="extension.html#type-Event">Event</a> 3235 </span> 3236 <span style="display: none; "> 3237 <span> 3238 array of <span><span></span></span> 3239 </span> 3240 <span>paramType</span> 3241 <span></span> 3242 </span> 3243 </span> 3244 ) 3245 </div> 3246 3247 </em> 3248 </dt> 3249 <dd class="todo"> 3250 Undocumented. 3251 </dd> 3252 <dd style="display: none; "> 3253 Description of this parameter from the json schema. 3254 </dd> 3255 <dd style="display: none; "> 3256 This parameter was added in version 3257 <b><span></span></b>. 3258 You must omit this parameter in earlier versions, 3259 and you may omit it in any version. If you require this 3260 parameter, the manifest key 3261 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3262 can ensure that your extension won't be run in an earlier browser version. 3263 </dd> 3264 3265 <!-- OBJECT PROPERTIES --> 3266 <dd style="display: none; "> 3267 <dl> 3268 <div> 3269 <div> 3270 </div> 3271 </div> 3272 </dl> 3273 </dd> 3274 3275 <!-- FUNCTION PARAMETERS --> 3276 <dd style="display: none; "> 3277 <div></div> 3278 </dd> 3279 3280 </div> 3281 </div><div> 3282 <div> 3283 <dt> 3284 <var>postMessage</var> 3285 <em> 3286 3287 <!-- TYPE --> 3288 <div style="display:inline"> 3289 ( 3290 <span class="optional" style="display: none; ">optional</span> 3291 <span class="enum" style="display: none; ">enumerated</span> 3292 <span id="typeTemplate"> 3293 <span style="display: none; "> 3294 <a> Type</a> 3295 </span> 3296 <span> 3297 <span style="display: none; "> 3298 array of <span><span></span></span> 3299 </span> 3300 <span>function</span> 3301 <span style="display: none; "></span> 3302 </span> 3303 </span> 3304 ) 3305 </div> 3306 3307 </em> 3308 </dt> 3309 <dd class="todo"> 3310 Undocumented. 3311 </dd> 3312 <dd style="display: none; "> 3313 Description of this parameter from the json schema. 3314 </dd> 3315 <dd style="display: none; "> 3316 This parameter was added in version 3317 <b><span></span></b>. 3318 You must omit this parameter in earlier versions, 3319 and you may omit it in any version. If you require this 3320 parameter, the manifest key 3321 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3322 can ensure that your extension won't be run in an earlier browser version. 3323 </dd> 3324 3325 <!-- OBJECT PROPERTIES --> 3326 <dd style="display: none; "> 3327 <dl> 3328 <div> 3329 <div> 3330 </div> 3331 </div> 3332 </dl> 3333 </dd> 3334 3335 <!-- FUNCTION PARAMETERS --> 3336 <dd style="display: none; "> 3337 <div></div> 3338 </dd> 3339 3340 </div> 3341 </div><div> 3342 <div> 3343 <dt> 3344 <var>sender</var> 3345 <em> 3346 3347 <!-- TYPE --> 3348 <div style="display:inline"> 3349 ( 3350 <span class="optional">optional</span> 3351 <span class="enum" style="display: none; ">enumerated</span> 3352 <span id="typeTemplate"> 3353 <span> 3354 <a href="extension.html#type-MessageSender">MessageSender</a> 3355 </span> 3356 <span style="display: none; "> 3357 <span> 3358 array of <span><span></span></span> 3359 </span> 3360 <span>paramType</span> 3361 <span></span> 3362 </span> 3363 </span> 3364 ) 3365 </div> 3366 3367 </em> 3368 </dt> 3369 <dd class="todo" style="display: none; "> 3370 Undocumented. 3371 </dd> 3372 <dd>This property will <b>only</b> be present on ports passed to onConnect/onConnectExternal listeners.</dd> 3373 <dd style="display: none; "> 3374 This parameter was added in version 3375 <b><span></span></b>. 3376 You must omit this parameter in earlier versions, 3377 and you may omit it in any version. If you require this 3378 parameter, the manifest key 3379 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3380 can ensure that your extension won't be run in an earlier browser version. 3381 </dd> 3382 3383 <!-- OBJECT PROPERTIES --> 3384 <dd style="display: none; "> 3385 <dl> 3386 <div> 3387 <div> 3388 </div> 3389 </div> 3390 </dl> 3391 </dd> 3392 3393 <!-- FUNCTION PARAMETERS --> 3394 <dd style="display: none; "> 3395 <div></div> 3396 </dd> 3397 3398 </div> 3399 </div> 3400 </dl> 3401 </dd> 3402 3403 <!-- FUNCTION PARAMETERS --> 3404 <dd style="display: none; "> 3405 <div></div> 3406 </dd> 3407 3408 </div> 3409 3410 </div> <!-- /apiItem --> 3411 3412 </div> <!-- /apiGroup --> 3413 3414 </div> <!-- /apiPage --> 3415 </div> <!-- /gc-pagecontent --> 3416 </div> <!-- /g-section --> 3417 </div> <!-- /codesiteContent --> 3418 <div id="gc-footer" --=""> 3419 <div class="text"> 3420 <p> 3421 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 3422 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 3423 Attribution 3.0 License</a>, and code samples are licensed under the 3424 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 3425 </p> 3426 <p> 3427 ©2010 Google 3428 </p> 3429 3430<!-- begin analytics --> 3431<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 3432<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 3433 3434<script type="text/javascript"> 3435 // chrome doc tracking 3436 try { 3437 var engdocs = _gat._getTracker("YT-10763712-2"); 3438 engdocs._trackPageview(); 3439 } catch(err) {} 3440 3441 // code.google.com site-wide tracking 3442 try { 3443 _uacct="UA-18071-1"; 3444 _uanchor=1; 3445 _uff=0; 3446 urchinTracker(); 3447 } 3448 catch(e) {/* urchinTracker not available. */} 3449</script> 3450<!-- end analytics --> 3451 </div> 3452 </div> <!-- /gc-footer --> 3453 </div> <!-- /gc-container --> 3454</body></html> 3455
