tabs.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>Tabs - 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 class="leftNavSelected">Tabs</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">Tabs</h1> 236 </div> 237 <!-- TABLE OF CONTENTS --> 238 <div id="toc"> 239 <h2>Contents</h2> 240 <ol> 241 <li> 242 <a href="#manifest">Manifest</a> 243 <ol> 244 <li style="display: none; "> 245 <a>h3Name</a> 246 </li> 247 </ol> 248 </li><li> 249 <a href="#examples"> Examples </a> 250 <ol> 251 <li style="display: none; "> 252 <a>h3Name</a> 253 </li> 254 </ol> 255 </li> 256 <li> 257 <a href="#apiReference">API reference: chrome.tabs</a> 258 <ol> 259 <li style="display: none; "> 260 <a href="#properties">Properties</a> 261 <ol> 262 <li> 263 <a href="#property-anchor">propertyName</a> 264 </li> 265 </ol> 266 </li> 267 <li> 268 <a href="#methods">Methods</a> 269 <ol> 270 <li> 271 <a href="#method-captureVisibleTab">captureVisibleTab</a> 272 </li><li> 273 <a href="#method-connect">connect</a> 274 </li><li> 275 <a href="#method-create">create</a> 276 </li><li> 277 <a href="#method-detectLanguage">detectLanguage</a> 278 </li><li> 279 <a href="#method-executeScript">executeScript</a> 280 </li><li> 281 <a href="#method-get">get</a> 282 </li><li> 283 <a href="#method-getAllInWindow">getAllInWindow</a> 284 </li><li> 285 <a href="#method-getCurrent">getCurrent</a> 286 </li><li> 287 <a href="#method-getSelected">getSelected</a> 288 </li><li> 289 <a href="#method-insertCSS">insertCSS</a> 290 </li><li> 291 <a href="#method-move">move</a> 292 </li><li> 293 <a href="#method-remove">remove</a> 294 </li><li> 295 <a href="#method-sendRequest">sendRequest</a> 296 </li><li> 297 <a href="#method-update">update</a> 298 </li> 299 </ol> 300 </li> 301 <li> 302 <a href="#events">Events</a> 303 <ol> 304 <li> 305 <a href="#event-onAttached">onAttached</a> 306 </li><li> 307 <a href="#event-onCreated">onCreated</a> 308 </li><li> 309 <a href="#event-onDetached">onDetached</a> 310 </li><li> 311 <a href="#event-onMoved">onMoved</a> 312 </li><li> 313 <a href="#event-onRemoved">onRemoved</a> 314 </li><li> 315 <a href="#event-onSelectionChanged">onSelectionChanged</a> 316 </li><li> 317 <a href="#event-onUpdated">onUpdated</a> 318 </li> 319 </ol> 320 </li> 321 <li> 322 <a href="#types">Types</a> 323 <ol> 324 <li> 325 <a href="#type-Tab">Tab</a> 326 </li> 327 </ol> 328 </li> 329 </ol> 330 </li> 331 </ol> 332 </div> 333 <!-- /TABLE OF CONTENTS --> 334 335 <!-- Standard content lead-in for experimental API pages --> 336 <p id="classSummary" style="display: none; "> 337 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 338 </p> 339 340 <!-- STATIC CONTENT PLACEHOLDER --> 341 <div id="static"><div id="pageData-name" class="pageData">Tabs</div> 342 343<!-- BEGIN AUTHORED CONTENT --> 344<p id="classSummary"> 345Use the <code>chrome.tabs</code> module 346to interact with the browser's tab system. 347You can use this module to 348create, modify, and rearrange tabs in the browser. 349</p> 350 351<img src="images/tabs.png" width="323" height="50" alt="Two tabs in a window"> 352 353<h2 id="manifest">Manifest</h2> 354<p>All but two functions* require you to declare the "tabs" permission in your extension's manifest to use the tabs API. 355For example: 356</p> 357 358<pre>{ 359 "name": "My extension", 360 ... 361 <b>"permissions": [ 362 "tabs" 363 ]</b>, 364 ... 365}</pre> 366 367<p>* The two functions that do not require the "tabs" permission are: tabs.create and tabs.update</p> 368<h2 id="examples"> Examples </h2> 369 370<p> 371You can find simple examples of using the tabs module in the 372<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/tabs/">examples/api/tabs</a> 373directory. 374For other examples and for help in viewing the source code, see 375<a href="samples.html">Samples</a>. 376</p> 377 378<!-- END AUTHORED CONTENT --> 379</div> 380 381 <!-- API PAGE --> 382 <div class="apiPage"> 383 <a name="apiReference"></a> 384 <h2>API reference: chrome.tabs</h2> 385 386 <!-- PROPERTIES --> 387 <div class="apiGroup" style="display: none; "> 388 <a name="properties"></a> 389 <h3 id="properties">Properties</h3> 390 391 <div> 392 <a></a> 393 <h4>getLastError</h4> 394 <div class="summary"> 395 <!-- Note: intentionally longer 80 columns --> 396 <span>chrome.extension</span><span>lastError</span> 397 </div> 398 <div> 399 </div> 400 </div> 401 402 </div> <!-- /apiGroup --> 403 404 <!-- METHODS --> 405 <div class="apiGroup" id="methods"> 406 <a name="methods"></a> 407 <h3>Methods</h3> 408 409 <!-- iterates over all functions --> 410 <div class="apiItem"> 411 <a name="method-captureVisibleTab"></a> <!-- method-anchor --> 412 <h4>captureVisibleTab</h4> 413 414 <div class="summary"><span style="display: none; ">void</span> 415 <!-- Note: intentionally longer 80 columns --> 416 <span>chrome.tabs.captureVisibleTab</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span> 417 <var><span>windowId</span></var></span><span class="optional"><span>, </span><span>object</span> 418 <var><span>options</span></var></span><span class="null"><span>, </span><span>function</span> 419 <var><span>callback</span></var></span>)</div> 420 421 <div class="description"> 422 <p class="todo" style="display: none; ">Undocumented.</p> 423 <p>Captures the visible area of the currently selected tab in the specified window.</p> 424 425 <!-- PARAMETERS --> 426 <h4>Parameters</h4> 427 <dl> 428 <div> 429 <div> 430 <dt> 431 <var>windowId</var> 432 <em> 433 434 <!-- TYPE --> 435 <div style="display:inline"> 436 ( 437 <span class="optional">optional</span> 438 <span class="enum" style="display: none; ">enumerated</span> 439 <span id="typeTemplate"> 440 <span style="display: none; "> 441 <a> Type</a> 442 </span> 443 <span> 444 <span style="display: none; "> 445 array of <span><span></span></span> 446 </span> 447 <span>integer</span> 448 <span style="display: none; "></span> 449 </span> 450 </span> 451 ) 452 </div> 453 454 </em> 455 </dt> 456 <dd class="todo" style="display: none; "> 457 Undocumented. 458 </dd> 459 <dd>The target window. Defaults to the <a href="windows.html#current-window">current window</a>.</dd> 460 <dd style="display: none; "> 461 This parameter was added in version 462 <b><span></span></b>. 463 You must omit this parameter in earlier versions, 464 and you may omit it in any version. If you require this 465 parameter, the manifest key 466 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 467 can ensure that your extension won't be run in an earlier browser version. 468 </dd> 469 470 <!-- OBJECT PROPERTIES --> 471 <dd style="display: none; "> 472 <dl> 473 <div> 474 <div> 475 </div> 476 </div> 477 </dl> 478 </dd> 479 480 <!-- FUNCTION PARAMETERS --> 481 <dd style="display: none; "> 482 <div></div> 483 </dd> 484 485 </div> 486 </div><div> 487 <div> 488 <dt> 489 <var>options</var> 490 <em> 491 492 <!-- TYPE --> 493 <div style="display:inline"> 494 ( 495 <span class="optional">optional</span> 496 <span class="enum" style="display: none; ">enumerated</span> 497 <span id="typeTemplate"> 498 <span style="display: none; "> 499 <a> Type</a> 500 </span> 501 <span> 502 <span style="display: none; "> 503 array of <span><span></span></span> 504 </span> 505 <span>object</span> 506 <span style="display: none; "></span> 507 </span> 508 </span> 509 ) 510 </div> 511 512 </em> 513 </dt> 514 <dd class="todo" style="display: none; "> 515 Undocumented. 516 </dd> 517 <dd>Set parameters of image capture, such as the format of the resulting image.</dd> 518 <dd> 519 This parameter was added in version 520 <b><span>5.0.372.0</span></b>. 521 You must omit this parameter in earlier versions, 522 and you may omit it in any version. If you require this 523 parameter, the manifest key 524 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 525 can ensure that your extension won't be run in an earlier browser version. 526 </dd> 527 528 <!-- OBJECT PROPERTIES --> 529 <dd> 530 <dl> 531 <div> 532 <div> 533 <dt> 534 <var>format</var> 535 <em> 536 537 <!-- TYPE --> 538 <div style="display:inline"> 539 ( 540 <span class="optional">optional</span> 541 <span class="enum">enumerated</span> 542 <span id="typeTemplate"> 543 <span style="display: none; "> 544 <a> Type</a> 545 </span> 546 <span> 547 <span style="display: none; "> 548 array of <span><span></span></span> 549 </span> 550 <span>string</span> 551 <span>["jpeg", "png"]</span> 552 </span> 553 </span> 554 ) 555 </div> 556 557 </em> 558 </dt> 559 <dd class="todo" style="display: none; "> 560 Undocumented. 561 </dd> 562 <dd>The format of the resulting image. Default is jpeg.</dd> 563 <dd style="display: none; "> 564 This parameter was added in version 565 <b><span></span></b>. 566 You must omit this parameter in earlier versions, 567 and you may omit it in any version. If you require this 568 parameter, the manifest key 569 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 570 can ensure that your extension won't be run in an earlier browser version. 571 </dd> 572 573 <!-- OBJECT PROPERTIES --> 574 <dd style="display: none; "> 575 <dl> 576 <div> 577 <div> 578 </div> 579 </div> 580 </dl> 581 </dd> 582 583 <!-- FUNCTION PARAMETERS --> 584 <dd style="display: none; "> 585 <div></div> 586 </dd> 587 588 </div> 589 </div><div> 590 <div> 591 <dt> 592 <var>quality</var> 593 <em> 594 595 <!-- TYPE --> 596 <div style="display:inline"> 597 ( 598 <span class="optional">optional</span> 599 <span class="enum" style="display: none; ">enumerated</span> 600 <span id="typeTemplate"> 601 <span style="display: none; "> 602 <a> Type</a> 603 </span> 604 <span> 605 <span style="display: none; "> 606 array of <span><span></span></span> 607 </span> 608 <span>integer</span> 609 <span style="display: none; "></span> 610 </span> 611 </span> 612 ) 613 </div> 614 615 </em> 616 </dt> 617 <dd class="todo" style="display: none; "> 618 Undocumented. 619 </dd> 620 <dd>When format is 'jpeg', controls the quality of the resulting image. This value is ignored for PNG images. As quality is decreased, the resulting image will have more visual artifacts, and the number of bytes needed to store it will decrease.</dd> 621 <dd style="display: none; "> 622 This parameter was added in version 623 <b><span></span></b>. 624 You must omit this parameter in earlier versions, 625 and you may omit it in any version. If you require this 626 parameter, the manifest key 627 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 628 can ensure that your extension won't be run in an earlier browser version. 629 </dd> 630 631 <!-- OBJECT PROPERTIES --> 632 <dd style="display: none; "> 633 <dl> 634 <div> 635 <div> 636 </div> 637 </div> 638 </dl> 639 </dd> 640 641 <!-- FUNCTION PARAMETERS --> 642 <dd style="display: none; "> 643 <div></div> 644 </dd> 645 646 </div> 647 </div> 648 </dl> 649 </dd> 650 651 <!-- FUNCTION PARAMETERS --> 652 <dd style="display: none; "> 653 <div></div> 654 </dd> 655 656 </div> 657 </div><div> 658 <div> 659 <dt> 660 <var>callback</var> 661 <em> 662 663 <!-- TYPE --> 664 <div style="display:inline"> 665 ( 666 <span class="optional" style="display: none; ">optional</span> 667 <span class="enum" style="display: none; ">enumerated</span> 668 <span id="typeTemplate"> 669 <span style="display: none; "> 670 <a> Type</a> 671 </span> 672 <span> 673 <span style="display: none; "> 674 array of <span><span></span></span> 675 </span> 676 <span>function</span> 677 <span style="display: none; "></span> 678 </span> 679 </span> 680 ) 681 </div> 682 683 </em> 684 </dt> 685 <dd class="todo"> 686 Undocumented. 687 </dd> 688 <dd style="display: none; "> 689 Description of this parameter from the json schema. 690 </dd> 691 <dd style="display: none; "> 692 This parameter was added in version 693 <b><span></span></b>. 694 You must omit this parameter in earlier versions, 695 and you may omit it in any version. If you require this 696 parameter, the manifest key 697 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 698 can ensure that your extension won't be run in an earlier browser version. 699 </dd> 700 701 <!-- OBJECT PROPERTIES --> 702 <dd style="display: none; "> 703 <dl> 704 <div> 705 <div> 706 </div> 707 </div> 708 </dl> 709 </dd> 710 711 <!-- FUNCTION PARAMETERS --> 712 <dd style="display: none; "> 713 <div></div> 714 </dd> 715 716 </div> 717 </div> 718 </dl> 719 720 <!-- RETURNS --> 721 <h4 style="display: none; ">Returns</h4> 722 <dl> 723 <div style="display: none; "> 724 <div> 725 </div> 726 </div> 727 </dl> 728 729 <!-- CALLBACK --> 730 <div> 731 <div> 732 <h4>Callback function</h4> 733 <p> 734 The callback <em>parameter</em> should specify a function 735 that looks like this: 736 </p> 737 <p style="display: none; "> 738 If you specify the <em>callback</em> parameter, it should 739 specify a function that looks like this: 740 </p> 741 742 <!-- Note: intentionally longer 80 columns --> 743 <pre>function(<span>string dataUrl</span>) <span class="subdued">{...}</span>;</pre> 744 <dl> 745 <div> 746 <div> 747 <dt> 748 <var>dataUrl</var> 749 <em> 750 751 <!-- TYPE --> 752 <div style="display:inline"> 753 ( 754 <span class="optional" style="display: none; ">optional</span> 755 <span class="enum" style="display: none; ">enumerated</span> 756 <span id="typeTemplate"> 757 <span style="display: none; "> 758 <a> Type</a> 759 </span> 760 <span> 761 <span style="display: none; "> 762 array of <span><span></span></span> 763 </span> 764 <span>string</span> 765 <span style="display: none; "></span> 766 </span> 767 </span> 768 ) 769 </div> 770 771 </em> 772 </dt> 773 <dd class="todo" style="display: none; "> 774 Undocumented. 775 </dd> 776 <dd>A data URL which encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML Image element for display.</dd> 777 <dd style="display: none; "> 778 This parameter was added in version 779 <b><span></span></b>. 780 You must omit this parameter in earlier versions, 781 and you may omit it in any version. If you require this 782 parameter, the manifest key 783 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 784 can ensure that your extension won't be run in an earlier browser version. 785 </dd> 786 787 <!-- OBJECT PROPERTIES --> 788 <dd style="display: none; "> 789 <dl> 790 <div> 791 <div> 792 </div> 793 </div> 794 </dl> 795 </dd> 796 797 <!-- FUNCTION PARAMETERS --> 798 <dd style="display: none; "> 799 <div></div> 800 </dd> 801 802 </div> 803 </div> 804 </dl> 805 </div> 806 </div> 807 808 <!-- MIN_VERSION --> 809 <p style="display: none; "> 810 This function was added in version <b><span></span></b>. 811 If you require this function, the manifest key 812 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 813 can ensure that your extension won't be run in an earlier browser version. 814 </p> 815 </div> <!-- /description --> 816 817 </div><div class="apiItem"> 818 <a name="method-connect"></a> <!-- method-anchor --> 819 <h4>connect</h4> 820 821 <div class="summary"><span>Port</span> 822 <!-- Note: intentionally longer 80 columns --> 823 <span>chrome.tabs.connect</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 824 <var><span>tabId</span></var></span><span class="optional"><span>, </span><span>object</span> 825 <var><span>connectInfo</span></var></span>)</div> 826 827 <div class="description"> 828 <p class="todo" style="display: none; ">Undocumented.</p> 829 <p>Connects to the content script(s) in the specified tab. The <a href="extension.html#event-onConnect">chrome.extension.onConnect</a> event is fired in each content script running in the specified tab for the current extension. For more details, see <a href="content_scripts.html#messaging">Content Script Messaging</a>.</p> 830 831 <!-- PARAMETERS --> 832 <h4>Parameters</h4> 833 <dl> 834 <div> 835 <div> 836 <dt> 837 <var>tabId</var> 838 <em> 839 840 <!-- TYPE --> 841 <div style="display:inline"> 842 ( 843 <span class="optional" style="display: none; ">optional</span> 844 <span class="enum" style="display: none; ">enumerated</span> 845 <span id="typeTemplate"> 846 <span style="display: none; "> 847 <a> Type</a> 848 </span> 849 <span> 850 <span style="display: none; "> 851 array of <span><span></span></span> 852 </span> 853 <span>integer</span> 854 <span style="display: none; "></span> 855 </span> 856 </span> 857 ) 858 </div> 859 860 </em> 861 </dt> 862 <dd class="todo"> 863 Undocumented. 864 </dd> 865 <dd style="display: none; "> 866 Description of this parameter from the json schema. 867 </dd> 868 <dd style="display: none; "> 869 This parameter was added in version 870 <b><span></span></b>. 871 You must omit this parameter in earlier versions, 872 and you may omit it in any version. If you require this 873 parameter, the manifest key 874 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 875 can ensure that your extension won't be run in an earlier browser version. 876 </dd> 877 878 <!-- OBJECT PROPERTIES --> 879 <dd style="display: none; "> 880 <dl> 881 <div> 882 <div> 883 </div> 884 </div> 885 </dl> 886 </dd> 887 888 <!-- FUNCTION PARAMETERS --> 889 <dd style="display: none; "> 890 <div></div> 891 </dd> 892 893 </div> 894 </div><div> 895 <div> 896 <dt> 897 <var>connectInfo</var> 898 <em> 899 900 <!-- TYPE --> 901 <div style="display:inline"> 902 ( 903 <span class="optional">optional</span> 904 <span class="enum" style="display: none; ">enumerated</span> 905 <span id="typeTemplate"> 906 <span style="display: none; "> 907 <a> Type</a> 908 </span> 909 <span> 910 <span style="display: none; "> 911 array of <span><span></span></span> 912 </span> 913 <span>object</span> 914 <span style="display: none; "></span> 915 </span> 916 </span> 917 ) 918 </div> 919 920 </em> 921 </dt> 922 <dd class="todo"> 923 Undocumented. 924 </dd> 925 <dd style="display: none; "> 926 Description of this parameter from the json schema. 927 </dd> 928 <dd style="display: none; "> 929 This parameter was added in version 930 <b><span></span></b>. 931 You must omit this parameter in earlier versions, 932 and you may omit it in any version. If you require this 933 parameter, the manifest key 934 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 935 can ensure that your extension won't be run in an earlier browser version. 936 </dd> 937 938 <!-- OBJECT PROPERTIES --> 939 <dd> 940 <dl> 941 <div> 942 <div> 943 <dt> 944 <var>name</var> 945 <em> 946 947 <!-- TYPE --> 948 <div style="display:inline"> 949 ( 950 <span class="optional">optional</span> 951 <span class="enum" style="display: none; ">enumerated</span> 952 <span id="typeTemplate"> 953 <span style="display: none; "> 954 <a> Type</a> 955 </span> 956 <span> 957 <span style="display: none; "> 958 array of <span><span></span></span> 959 </span> 960 <span>string</span> 961 <span style="display: none; "></span> 962 </span> 963 </span> 964 ) 965 </div> 966 967 </em> 968 </dt> 969 <dd class="todo" style="display: none; "> 970 Undocumented. 971 </dd> 972 <dd>Will be passed into onConnect for content scripts that are listening for the connection event.</dd> 973 <dd style="display: none; "> 974 This parameter was added in version 975 <b><span></span></b>. 976 You must omit this parameter in earlier versions, 977 and you may omit it in any version. If you require this 978 parameter, the manifest key 979 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 980 can ensure that your extension won't be run in an earlier browser version. 981 </dd> 982 983 <!-- OBJECT PROPERTIES --> 984 <dd style="display: none; "> 985 <dl> 986 <div> 987 <div> 988 </div> 989 </div> 990 </dl> 991 </dd> 992 993 <!-- FUNCTION PARAMETERS --> 994 <dd style="display: none; "> 995 <div></div> 996 </dd> 997 998 </div> 999 </div> 1000 </dl> 1001 </dd> 1002 1003 <!-- FUNCTION PARAMETERS --> 1004 <dd style="display: none; "> 1005 <div></div> 1006 </dd> 1007 1008 </div> 1009 </div> 1010 </dl> 1011 1012 <!-- RETURNS --> 1013 <h4>Returns</h4> 1014 <dl> 1015 <div> 1016 <div> 1017 <dt> 1018 <var style="display: none; ">paramName</var> 1019 <em> 1020 1021 <!-- TYPE --> 1022 <div style="display:inline"> 1023 ( 1024 <span class="optional" style="display: none; ">optional</span> 1025 <span class="enum" style="display: none; ">enumerated</span> 1026 <span id="typeTemplate"> 1027 <span> 1028 <a href="extension.html#type-Port">Port</a> 1029 </span> 1030 <span style="display: none; "> 1031 <span> 1032 array of <span><span></span></span> 1033 </span> 1034 <span>paramType</span> 1035 <span></span> 1036 </span> 1037 </span> 1038 ) 1039 </div> 1040 1041 </em> 1042 </dt> 1043 <dd class="todo" style="display: none; "> 1044 Undocumented. 1045 </dd> 1046 <dd>A port that can be used to communicate with the content scripts running in the specified tab. The port's <a href="extension.html#type-Port">onDisconnect</a> event is fired if the tab closes or does not exist. </dd> 1047 <dd style="display: none; "> 1048 This parameter was added in version 1049 <b><span></span></b>. 1050 You must omit this parameter in earlier versions, 1051 and you may omit it in any version. If you require this 1052 parameter, the manifest key 1053 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1054 can ensure that your extension won't be run in an earlier browser version. 1055 </dd> 1056 1057 <!-- OBJECT PROPERTIES --> 1058 <dd style="display: none; "> 1059 <dl> 1060 <div> 1061 <div> 1062 </div> 1063 </div> 1064 </dl> 1065 </dd> 1066 1067 <!-- FUNCTION PARAMETERS --> 1068 <dd style="display: none; "> 1069 <div></div> 1070 </dd> 1071 1072 </div> 1073 </div> 1074 </dl> 1075 1076 <!-- CALLBACK --> 1077 <div style="display: none; "> 1078 <div> 1079 <h4>Callback function</h4> 1080 <p> 1081 The callback <em>parameter</em> should specify a function 1082 that looks like this: 1083 </p> 1084 <p> 1085 If you specify the <em>callback</em> parameter, it should 1086 specify a function that looks like this: 1087 </p> 1088 1089 <!-- Note: intentionally longer 80 columns --> 1090 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1091 <dl> 1092 <div> 1093 <div> 1094 </div> 1095 </div> 1096 </dl> 1097 </div> 1098 </div> 1099 1100 <!-- MIN_VERSION --> 1101 <p style="display: none; "> 1102 This function was added in version <b><span></span></b>. 1103 If you require this function, the manifest key 1104 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1105 can ensure that your extension won't be run in an earlier browser version. 1106 </p> 1107 </div> <!-- /description --> 1108 1109 </div><div class="apiItem"> 1110 <a name="method-create"></a> <!-- method-anchor --> 1111 <h4>create</h4> 1112 1113 <div class="summary"><span style="display: none; ">void</span> 1114 <!-- Note: intentionally longer 80 columns --> 1115 <span>chrome.tabs.create</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1116 <var><span>createProperties</span></var></span><span class="optional"><span>, </span><span>function</span> 1117 <var><span>callback</span></var></span>)</div> 1118 1119 <div class="description"> 1120 <p class="todo" style="display: none; ">Undocumented.</p> 1121 <p>Creates a new tab. Note: This function can be used without requesting the 'tabs' permission in the manifest.</p> 1122 1123 <!-- PARAMETERS --> 1124 <h4>Parameters</h4> 1125 <dl> 1126 <div> 1127 <div> 1128 <dt> 1129 <var>createProperties</var> 1130 <em> 1131 1132 <!-- TYPE --> 1133 <div style="display:inline"> 1134 ( 1135 <span class="optional" style="display: none; ">optional</span> 1136 <span class="enum" style="display: none; ">enumerated</span> 1137 <span id="typeTemplate"> 1138 <span style="display: none; "> 1139 <a> Type</a> 1140 </span> 1141 <span> 1142 <span style="display: none; "> 1143 array of <span><span></span></span> 1144 </span> 1145 <span>object</span> 1146 <span style="display: none; "></span> 1147 </span> 1148 </span> 1149 ) 1150 </div> 1151 1152 </em> 1153 </dt> 1154 <dd class="todo"> 1155 Undocumented. 1156 </dd> 1157 <dd style="display: none; "> 1158 Description of this parameter from the json schema. 1159 </dd> 1160 <dd style="display: none; "> 1161 This parameter was added in version 1162 <b><span></span></b>. 1163 You must omit this parameter in earlier versions, 1164 and you may omit it in any version. If you require this 1165 parameter, the manifest key 1166 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1167 can ensure that your extension won't be run in an earlier browser version. 1168 </dd> 1169 1170 <!-- OBJECT PROPERTIES --> 1171 <dd> 1172 <dl> 1173 <div> 1174 <div> 1175 <dt> 1176 <var>windowId</var> 1177 <em> 1178 1179 <!-- TYPE --> 1180 <div style="display:inline"> 1181 ( 1182 <span class="optional">optional</span> 1183 <span class="enum" style="display: none; ">enumerated</span> 1184 <span id="typeTemplate"> 1185 <span style="display: none; "> 1186 <a> Type</a> 1187 </span> 1188 <span> 1189 <span style="display: none; "> 1190 array of <span><span></span></span> 1191 </span> 1192 <span>integer</span> 1193 <span style="display: none; "></span> 1194 </span> 1195 </span> 1196 ) 1197 </div> 1198 1199 </em> 1200 </dt> 1201 <dd class="todo" style="display: none; "> 1202 Undocumented. 1203 </dd> 1204 <dd>The window to create the new tab in. Defaults to the <a href="windows.html#current-window">current window</a>.</dd> 1205 <dd style="display: none; "> 1206 This parameter was added in version 1207 <b><span></span></b>. 1208 You must omit this parameter in earlier versions, 1209 and you may omit it in any version. If you require this 1210 parameter, the manifest key 1211 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1212 can ensure that your extension won't be run in an earlier browser version. 1213 </dd> 1214 1215 <!-- OBJECT PROPERTIES --> 1216 <dd style="display: none; "> 1217 <dl> 1218 <div> 1219 <div> 1220 </div> 1221 </div> 1222 </dl> 1223 </dd> 1224 1225 <!-- FUNCTION PARAMETERS --> 1226 <dd style="display: none; "> 1227 <div></div> 1228 </dd> 1229 1230 </div> 1231 </div><div> 1232 <div> 1233 <dt> 1234 <var>index</var> 1235 <em> 1236 1237 <!-- TYPE --> 1238 <div style="display:inline"> 1239 ( 1240 <span class="optional">optional</span> 1241 <span class="enum" style="display: none; ">enumerated</span> 1242 <span id="typeTemplate"> 1243 <span style="display: none; "> 1244 <a> Type</a> 1245 </span> 1246 <span> 1247 <span style="display: none; "> 1248 array of <span><span></span></span> 1249 </span> 1250 <span>integer</span> 1251 <span style="display: none; "></span> 1252 </span> 1253 </span> 1254 ) 1255 </div> 1256 1257 </em> 1258 </dt> 1259 <dd class="todo" style="display: none; "> 1260 Undocumented. 1261 </dd> 1262 <dd>The position the tab should take in the window. The provided value will be clamped to between zero and the number of tabs in the window.</dd> 1263 <dd style="display: none; "> 1264 This parameter was added in version 1265 <b><span></span></b>. 1266 You must omit this parameter in earlier versions, 1267 and you may omit it in any version. If you require this 1268 parameter, the manifest key 1269 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1270 can ensure that your extension won't be run in an earlier browser version. 1271 </dd> 1272 1273 <!-- OBJECT PROPERTIES --> 1274 <dd style="display: none; "> 1275 <dl> 1276 <div> 1277 <div> 1278 </div> 1279 </div> 1280 </dl> 1281 </dd> 1282 1283 <!-- FUNCTION PARAMETERS --> 1284 <dd style="display: none; "> 1285 <div></div> 1286 </dd> 1287 1288 </div> 1289 </div><div> 1290 <div> 1291 <dt> 1292 <var>url</var> 1293 <em> 1294 1295 <!-- TYPE --> 1296 <div style="display:inline"> 1297 ( 1298 <span class="optional">optional</span> 1299 <span class="enum" style="display: none; ">enumerated</span> 1300 <span id="typeTemplate"> 1301 <span style="display: none; "> 1302 <a> Type</a> 1303 </span> 1304 <span> 1305 <span style="display: none; "> 1306 array of <span><span></span></span> 1307 </span> 1308 <span>string</span> 1309 <span style="display: none; "></span> 1310 </span> 1311 </span> 1312 ) 1313 </div> 1314 1315 </em> 1316 </dt> 1317 <dd class="todo" style="display: none; "> 1318 Undocumented. 1319 </dd> 1320 <dd>The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.</dd> 1321 <dd style="display: none; "> 1322 This parameter was added in version 1323 <b><span></span></b>. 1324 You must omit this parameter in earlier versions, 1325 and you may omit it in any version. If you require this 1326 parameter, the manifest key 1327 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1328 can ensure that your extension won't be run in an earlier browser version. 1329 </dd> 1330 1331 <!-- OBJECT PROPERTIES --> 1332 <dd style="display: none; "> 1333 <dl> 1334 <div> 1335 <div> 1336 </div> 1337 </div> 1338 </dl> 1339 </dd> 1340 1341 <!-- FUNCTION PARAMETERS --> 1342 <dd style="display: none; "> 1343 <div></div> 1344 </dd> 1345 1346 </div> 1347 </div><div> 1348 <div> 1349 <dt> 1350 <var>selected</var> 1351 <em> 1352 1353 <!-- TYPE --> 1354 <div style="display:inline"> 1355 ( 1356 <span class="optional">optional</span> 1357 <span class="enum" style="display: none; ">enumerated</span> 1358 <span id="typeTemplate"> 1359 <span style="display: none; "> 1360 <a> Type</a> 1361 </span> 1362 <span> 1363 <span style="display: none; "> 1364 array of <span><span></span></span> 1365 </span> 1366 <span>boolean</span> 1367 <span style="display: none; "></span> 1368 </span> 1369 </span> 1370 ) 1371 </div> 1372 1373 </em> 1374 </dt> 1375 <dd class="todo" style="display: none; "> 1376 Undocumented. 1377 </dd> 1378 <dd>Whether the tab should become the selected tab in the window. Defaults to <var>true</var></dd> 1379 <dd style="display: none; "> 1380 This parameter was added in version 1381 <b><span></span></b>. 1382 You must omit this parameter in earlier versions, 1383 and you may omit it in any version. If you require this 1384 parameter, the manifest key 1385 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1386 can ensure that your extension won't be run in an earlier browser version. 1387 </dd> 1388 1389 <!-- OBJECT PROPERTIES --> 1390 <dd style="display: none; "> 1391 <dl> 1392 <div> 1393 <div> 1394 </div> 1395 </div> 1396 </dl> 1397 </dd> 1398 1399 <!-- FUNCTION PARAMETERS --> 1400 <dd style="display: none; "> 1401 <div></div> 1402 </dd> 1403 1404 </div> 1405 </div><div> 1406 <div> 1407 <dt> 1408 <var>pinned</var> 1409 <em> 1410 1411 <!-- TYPE --> 1412 <div style="display:inline"> 1413 ( 1414 <span class="optional">optional</span> 1415 <span class="enum" style="display: none; ">enumerated</span> 1416 <span id="typeTemplate"> 1417 <span style="display: none; "> 1418 <a> Type</a> 1419 </span> 1420 <span> 1421 <span style="display: none; "> 1422 array of <span><span></span></span> 1423 </span> 1424 <span>boolean</span> 1425 <span style="display: none; "></span> 1426 </span> 1427 </span> 1428 ) 1429 </div> 1430 1431 </em> 1432 </dt> 1433 <dd class="todo" style="display: none; "> 1434 Undocumented. 1435 </dd> 1436 <dd>Whether the tab should be pinned. Defaults to <var>false</var></dd> 1437 <dd style="display: none; "> 1438 This parameter was added in version 1439 <b><span></span></b>. 1440 You must omit this parameter in earlier versions, 1441 and you may omit it in any version. If you require this 1442 parameter, the manifest key 1443 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1444 can ensure that your extension won't be run in an earlier browser version. 1445 </dd> 1446 1447 <!-- OBJECT PROPERTIES --> 1448 <dd style="display: none; "> 1449 <dl> 1450 <div> 1451 <div> 1452 </div> 1453 </div> 1454 </dl> 1455 </dd> 1456 1457 <!-- FUNCTION PARAMETERS --> 1458 <dd style="display: none; "> 1459 <div></div> 1460 </dd> 1461 1462 </div> 1463 </div> 1464 </dl> 1465 </dd> 1466 1467 <!-- FUNCTION PARAMETERS --> 1468 <dd style="display: none; "> 1469 <div></div> 1470 </dd> 1471 1472 </div> 1473 </div><div> 1474 <div> 1475 <dt> 1476 <var>callback</var> 1477 <em> 1478 1479 <!-- TYPE --> 1480 <div style="display:inline"> 1481 ( 1482 <span class="optional">optional</span> 1483 <span class="enum" style="display: none; ">enumerated</span> 1484 <span id="typeTemplate"> 1485 <span style="display: none; "> 1486 <a> Type</a> 1487 </span> 1488 <span> 1489 <span style="display: none; "> 1490 array of <span><span></span></span> 1491 </span> 1492 <span>function</span> 1493 <span style="display: none; "></span> 1494 </span> 1495 </span> 1496 ) 1497 </div> 1498 1499 </em> 1500 </dt> 1501 <dd class="todo"> 1502 Undocumented. 1503 </dd> 1504 <dd style="display: none; "> 1505 Description of this parameter from the json schema. 1506 </dd> 1507 <dd style="display: none; "> 1508 This parameter was added in version 1509 <b><span></span></b>. 1510 You must omit this parameter in earlier versions, 1511 and you may omit it in any version. If you require this 1512 parameter, the manifest key 1513 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1514 can ensure that your extension won't be run in an earlier browser version. 1515 </dd> 1516 1517 <!-- OBJECT PROPERTIES --> 1518 <dd style="display: none; "> 1519 <dl> 1520 <div> 1521 <div> 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 style="display: none; ">Returns</h4> 1538 <dl> 1539 <div style="display: none; "> 1540 <div> 1541 </div> 1542 </div> 1543 </dl> 1544 1545 <!-- CALLBACK --> 1546 <div> 1547 <div> 1548 <h4>Callback function</h4> 1549 <p style="display: none; "> 1550 The callback <em>parameter</em> should specify a function 1551 that looks like this: 1552 </p> 1553 <p> 1554 If you specify the <em>callback</em> parameter, it should 1555 specify a function that looks like this: 1556 </p> 1557 1558 <!-- Note: intentionally longer 80 columns --> 1559 <pre>function(<span>Tab tab</span>) <span class="subdued">{...}</span>;</pre> 1560 <dl> 1561 <div> 1562 <div> 1563 <dt> 1564 <var>tab</var> 1565 <em> 1566 1567 <!-- TYPE --> 1568 <div style="display:inline"> 1569 ( 1570 <span class="optional" style="display: none; ">optional</span> 1571 <span class="enum" style="display: none; ">enumerated</span> 1572 <span id="typeTemplate"> 1573 <span> 1574 <a href="tabs.html#type-Tab">Tab</a> 1575 </span> 1576 <span style="display: none; "> 1577 <span> 1578 array of <span><span></span></span> 1579 </span> 1580 <span>paramType</span> 1581 <span></span> 1582 </span> 1583 </span> 1584 ) 1585 </div> 1586 1587 </em> 1588 </dt> 1589 <dd class="todo" style="display: none; "> 1590 Undocumented. 1591 </dd> 1592 <dd>Details about the created tab. Will contain the ID of the new tab.</dd> 1593 <dd style="display: none; "> 1594 This parameter was added in version 1595 <b><span></span></b>. 1596 You must omit this parameter in earlier versions, 1597 and you may omit it in any version. If you require this 1598 parameter, the manifest key 1599 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1600 can ensure that your extension won't be run in an earlier browser version. 1601 </dd> 1602 1603 <!-- OBJECT PROPERTIES --> 1604 <dd style="display: none; "> 1605 <dl> 1606 <div> 1607 <div> 1608 </div> 1609 </div> 1610 </dl> 1611 </dd> 1612 1613 <!-- FUNCTION PARAMETERS --> 1614 <dd style="display: none; "> 1615 <div></div> 1616 </dd> 1617 1618 </div> 1619 </div> 1620 </dl> 1621 </div> 1622 </div> 1623 1624 <!-- MIN_VERSION --> 1625 <p style="display: none; "> 1626 This function was added in version <b><span></span></b>. 1627 If you require this function, the manifest key 1628 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1629 can ensure that your extension won't be run in an earlier browser version. 1630 </p> 1631 </div> <!-- /description --> 1632 1633 </div><div class="apiItem"> 1634 <a name="method-detectLanguage"></a> <!-- method-anchor --> 1635 <h4>detectLanguage</h4> 1636 1637 <div class="summary"><span style="display: none; ">void</span> 1638 <!-- Note: intentionally longer 80 columns --> 1639 <span>chrome.tabs.detectLanguage</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span> 1640 <var><span>tabId</span></var></span><span class="null"><span>, </span><span>function</span> 1641 <var><span>callback</span></var></span>)</div> 1642 1643 <div class="description"> 1644 <p class="todo" style="display: none; ">Undocumented.</p> 1645 <p>Detects the primary language of the content in a tab.</p> 1646 1647 <!-- PARAMETERS --> 1648 <h4>Parameters</h4> 1649 <dl> 1650 <div> 1651 <div> 1652 <dt> 1653 <var>tabId</var> 1654 <em> 1655 1656 <!-- TYPE --> 1657 <div style="display:inline"> 1658 ( 1659 <span class="optional">optional</span> 1660 <span class="enum" style="display: none; ">enumerated</span> 1661 <span id="typeTemplate"> 1662 <span style="display: none; "> 1663 <a> Type</a> 1664 </span> 1665 <span> 1666 <span style="display: none; "> 1667 array of <span><span></span></span> 1668 </span> 1669 <span>integer</span> 1670 <span style="display: none; "></span> 1671 </span> 1672 </span> 1673 ) 1674 </div> 1675 1676 </em> 1677 </dt> 1678 <dd class="todo" style="display: none; "> 1679 Undocumented. 1680 </dd> 1681 <dd>Defaults to the selected tab of the <a href="windows.html#current-window">current window</a>.</dd> 1682 <dd style="display: none; "> 1683 This parameter was added in version 1684 <b><span></span></b>. 1685 You must omit this parameter in earlier versions, 1686 and you may omit it in any version. If you require this 1687 parameter, the manifest key 1688 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1689 can ensure that your extension won't be run in an earlier browser version. 1690 </dd> 1691 1692 <!-- OBJECT PROPERTIES --> 1693 <dd style="display: none; "> 1694 <dl> 1695 <div> 1696 <div> 1697 </div> 1698 </div> 1699 </dl> 1700 </dd> 1701 1702 <!-- FUNCTION PARAMETERS --> 1703 <dd style="display: none; "> 1704 <div></div> 1705 </dd> 1706 1707 </div> 1708 </div><div> 1709 <div> 1710 <dt> 1711 <var>callback</var> 1712 <em> 1713 1714 <!-- TYPE --> 1715 <div style="display:inline"> 1716 ( 1717 <span class="optional" style="display: none; ">optional</span> 1718 <span class="enum" style="display: none; ">enumerated</span> 1719 <span id="typeTemplate"> 1720 <span style="display: none; "> 1721 <a> Type</a> 1722 </span> 1723 <span> 1724 <span style="display: none; "> 1725 array of <span><span></span></span> 1726 </span> 1727 <span>function</span> 1728 <span style="display: none; "></span> 1729 </span> 1730 </span> 1731 ) 1732 </div> 1733 1734 </em> 1735 </dt> 1736 <dd class="todo"> 1737 Undocumented. 1738 </dd> 1739 <dd style="display: none; "> 1740 Description of this parameter from the json schema. 1741 </dd> 1742 <dd style="display: none; "> 1743 This parameter was added in version 1744 <b><span></span></b>. 1745 You must omit this parameter in earlier versions, 1746 and you may omit it in any version. If you require this 1747 parameter, the manifest key 1748 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1749 can ensure that your extension won't be run in an earlier browser version. 1750 </dd> 1751 1752 <!-- OBJECT PROPERTIES --> 1753 <dd style="display: none; "> 1754 <dl> 1755 <div> 1756 <div> 1757 </div> 1758 </div> 1759 </dl> 1760 </dd> 1761 1762 <!-- FUNCTION PARAMETERS --> 1763 <dd style="display: none; "> 1764 <div></div> 1765 </dd> 1766 1767 </div> 1768 </div> 1769 </dl> 1770 1771 <!-- RETURNS --> 1772 <h4 style="display: none; ">Returns</h4> 1773 <dl> 1774 <div style="display: none; "> 1775 <div> 1776 </div> 1777 </div> 1778 </dl> 1779 1780 <!-- CALLBACK --> 1781 <div> 1782 <div> 1783 <h4>Callback function</h4> 1784 <p> 1785 The callback <em>parameter</em> should specify a function 1786 that looks like this: 1787 </p> 1788 <p style="display: none; "> 1789 If you specify the <em>callback</em> parameter, it should 1790 specify a function that looks like this: 1791 </p> 1792 1793 <!-- Note: intentionally longer 80 columns --> 1794 <pre>function(<span>string language</span>) <span class="subdued">{...}</span>;</pre> 1795 <dl> 1796 <div> 1797 <div> 1798 <dt> 1799 <var>language</var> 1800 <em> 1801 1802 <!-- TYPE --> 1803 <div style="display:inline"> 1804 ( 1805 <span class="optional" style="display: none; ">optional</span> 1806 <span class="enum" style="display: none; ">enumerated</span> 1807 <span id="typeTemplate"> 1808 <span style="display: none; "> 1809 <a> Type</a> 1810 </span> 1811 <span> 1812 <span style="display: none; "> 1813 array of <span><span></span></span> 1814 </span> 1815 <span>string</span> 1816 <span style="display: none; "></span> 1817 </span> 1818 </span> 1819 ) 1820 </div> 1821 1822 </em> 1823 </dt> 1824 <dd class="todo" style="display: none; "> 1825 Undocumented. 1826 </dd> 1827 <dd>An ISO language code such as <code>en</code> or <code>fr</code>. For a complete list of languages supported by this method, see <a href="http://src.chromium.org/viewvc/chrome/trunk/src/third_party/cld/languages/internal/languages.cc">kLanguageInfoTable</a>. The 2nd to 4th columns will be checked and the first non-NULL value will be returned except for Simplified Chinese for which zh-CN will be returned. For an unknown language, <code>und</code> will be returned.</dd> 1828 <dd style="display: none; "> 1829 This parameter was added in version 1830 <b><span></span></b>. 1831 You must omit this parameter in earlier versions, 1832 and you may omit it in any version. If you require this 1833 parameter, the manifest key 1834 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1835 can ensure that your extension won't be run in an earlier browser version. 1836 </dd> 1837 1838 <!-- OBJECT PROPERTIES --> 1839 <dd style="display: none; "> 1840 <dl> 1841 <div> 1842 <div> 1843 </div> 1844 </div> 1845 </dl> 1846 </dd> 1847 1848 <!-- FUNCTION PARAMETERS --> 1849 <dd style="display: none; "> 1850 <div></div> 1851 </dd> 1852 1853 </div> 1854 </div> 1855 </dl> 1856 </div> 1857 </div> 1858 1859 <!-- MIN_VERSION --> 1860 <p style="display: none; "> 1861 This function was added in version <b><span></span></b>. 1862 If you require this function, the manifest key 1863 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1864 can ensure that your extension won't be run in an earlier browser version. 1865 </p> 1866 </div> <!-- /description --> 1867 1868 </div><div class="apiItem"> 1869 <a name="method-executeScript"></a> <!-- method-anchor --> 1870 <h4>executeScript</h4> 1871 1872 <div class="summary"><span style="display: none; ">void</span> 1873 <!-- Note: intentionally longer 80 columns --> 1874 <span>chrome.tabs.executeScript</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span> 1875 <var><span>tabId</span></var></span><span class="null"><span>, </span><span>object</span> 1876 <var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span> 1877 <var><span>callback</span></var></span>)</div> 1878 1879 <div class="description"> 1880 <p class="todo" style="display: none; ">Undocumented.</p> 1881 <p>Injects JavaScript code into a page. For details, see the <a href="content_scripts.html#pi">programmatic injection</a> section of the content scripts doc.</p> 1882 1883 <!-- PARAMETERS --> 1884 <h4>Parameters</h4> 1885 <dl> 1886 <div> 1887 <div> 1888 <dt> 1889 <var>tabId</var> 1890 <em> 1891 1892 <!-- TYPE --> 1893 <div style="display:inline"> 1894 ( 1895 <span class="optional">optional</span> 1896 <span class="enum" style="display: none; ">enumerated</span> 1897 <span id="typeTemplate"> 1898 <span style="display: none; "> 1899 <a> Type</a> 1900 </span> 1901 <span> 1902 <span style="display: none; "> 1903 array of <span><span></span></span> 1904 </span> 1905 <span>integer</span> 1906 <span style="display: none; "></span> 1907 </span> 1908 </span> 1909 ) 1910 </div> 1911 1912 </em> 1913 </dt> 1914 <dd class="todo" style="display: none; "> 1915 Undocumented. 1916 </dd> 1917 <dd>The ID of the tab in which to run the script; defaults to the selected tab of the current window.</dd> 1918 <dd style="display: none; "> 1919 This parameter was added in version 1920 <b><span></span></b>. 1921 You must omit this parameter in earlier versions, 1922 and you may omit it in any version. If you require this 1923 parameter, the manifest key 1924 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1925 can ensure that your extension won't be run in an earlier browser version. 1926 </dd> 1927 1928 <!-- OBJECT PROPERTIES --> 1929 <dd style="display: none; "> 1930 <dl> 1931 <div> 1932 <div> 1933 </div> 1934 </div> 1935 </dl> 1936 </dd> 1937 1938 <!-- FUNCTION PARAMETERS --> 1939 <dd style="display: none; "> 1940 <div></div> 1941 </dd> 1942 1943 </div> 1944 </div><div> 1945 <div> 1946 <dt> 1947 <var>details</var> 1948 <em> 1949 1950 <!-- TYPE --> 1951 <div style="display:inline"> 1952 ( 1953 <span class="optional" style="display: none; ">optional</span> 1954 <span class="enum" style="display: none; ">enumerated</span> 1955 <span id="typeTemplate"> 1956 <span style="display: none; "> 1957 <a> Type</a> 1958 </span> 1959 <span> 1960 <span style="display: none; "> 1961 array of <span><span></span></span> 1962 </span> 1963 <span>object</span> 1964 <span style="display: none; "></span> 1965 </span> 1966 </span> 1967 ) 1968 </div> 1969 1970 </em> 1971 </dt> 1972 <dd class="todo" style="display: none; "> 1973 Undocumented. 1974 </dd> 1975 <dd>Details of the script to run. Either the code or the file property must be set, but both may not be set at the same time.</dd> 1976 <dd style="display: none; "> 1977 This parameter was added in version 1978 <b><span></span></b>. 1979 You must omit this parameter in earlier versions, 1980 and you may omit it in any version. If you require this 1981 parameter, the manifest key 1982 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1983 can ensure that your extension won't be run in an earlier browser version. 1984 </dd> 1985 1986 <!-- OBJECT PROPERTIES --> 1987 <dd> 1988 <dl> 1989 <div> 1990 <div> 1991 <dt> 1992 <var>code</var> 1993 <em> 1994 1995 <!-- TYPE --> 1996 <div style="display:inline"> 1997 ( 1998 <span class="optional">optional</span> 1999 <span class="enum" style="display: none; ">enumerated</span> 2000 <span id="typeTemplate"> 2001 <span style="display: none; "> 2002 <a> Type</a> 2003 </span> 2004 <span> 2005 <span style="display: none; "> 2006 array of <span><span></span></span> 2007 </span> 2008 <span>string</span> 2009 <span style="display: none; "></span> 2010 </span> 2011 </span> 2012 ) 2013 </div> 2014 2015 </em> 2016 </dt> 2017 <dd class="todo" style="display: none; "> 2018 Undocumented. 2019 </dd> 2020 <dd>JavaScript code to execute.</dd> 2021 <dd style="display: none; "> 2022 This parameter was added in version 2023 <b><span></span></b>. 2024 You must omit this parameter in earlier versions, 2025 and you may omit it in any version. If you require this 2026 parameter, the manifest key 2027 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2028 can ensure that your extension won't be run in an earlier browser version. 2029 </dd> 2030 2031 <!-- OBJECT PROPERTIES --> 2032 <dd style="display: none; "> 2033 <dl> 2034 <div> 2035 <div> 2036 </div> 2037 </div> 2038 </dl> 2039 </dd> 2040 2041 <!-- FUNCTION PARAMETERS --> 2042 <dd style="display: none; "> 2043 <div></div> 2044 </dd> 2045 2046 </div> 2047 </div><div> 2048 <div> 2049 <dt> 2050 <var>file</var> 2051 <em> 2052 2053 <!-- TYPE --> 2054 <div style="display:inline"> 2055 ( 2056 <span class="optional">optional</span> 2057 <span class="enum" style="display: none; ">enumerated</span> 2058 <span id="typeTemplate"> 2059 <span style="display: none; "> 2060 <a> Type</a> 2061 </span> 2062 <span> 2063 <span style="display: none; "> 2064 array of <span><span></span></span> 2065 </span> 2066 <span>string</span> 2067 <span style="display: none; "></span> 2068 </span> 2069 </span> 2070 ) 2071 </div> 2072 2073 </em> 2074 </dt> 2075 <dd class="todo" style="display: none; "> 2076 Undocumented. 2077 </dd> 2078 <dd>JavaScript file to execute.</dd> 2079 <dd style="display: none; "> 2080 This parameter was added in version 2081 <b><span></span></b>. 2082 You must omit this parameter in earlier versions, 2083 and you may omit it in any version. If you require this 2084 parameter, the manifest key 2085 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2086 can ensure that your extension won't be run in an earlier browser version. 2087 </dd> 2088 2089 <!-- OBJECT PROPERTIES --> 2090 <dd style="display: none; "> 2091 <dl> 2092 <div> 2093 <div> 2094 </div> 2095 </div> 2096 </dl> 2097 </dd> 2098 2099 <!-- FUNCTION PARAMETERS --> 2100 <dd style="display: none; "> 2101 <div></div> 2102 </dd> 2103 2104 </div> 2105 </div><div> 2106 <div> 2107 <dt> 2108 <var>allFrames</var> 2109 <em> 2110 2111 <!-- TYPE --> 2112 <div style="display:inline"> 2113 ( 2114 <span class="optional">optional</span> 2115 <span class="enum" style="display: none; ">enumerated</span> 2116 <span id="typeTemplate"> 2117 <span style="display: none; "> 2118 <a> Type</a> 2119 </span> 2120 <span> 2121 <span style="display: none; "> 2122 array of <span><span></span></span> 2123 </span> 2124 <span>boolean</span> 2125 <span style="display: none; "></span> 2126 </span> 2127 </span> 2128 ) 2129 </div> 2130 2131 </em> 2132 </dt> 2133 <dd class="todo" style="display: none; "> 2134 Undocumented. 2135 </dd> 2136 <dd>If allFrames is true, this function injects script into all frames of current page. By default, it's false and script is injected only into the top main frame.</dd> 2137 <dd style="display: none; "> 2138 This parameter was added in version 2139 <b><span></span></b>. 2140 You must omit this parameter in earlier versions, 2141 and you may omit it in any version. If you require this 2142 parameter, the manifest key 2143 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2144 can ensure that your extension won't be run in an earlier browser version. 2145 </dd> 2146 2147 <!-- OBJECT PROPERTIES --> 2148 <dd style="display: none; "> 2149 <dl> 2150 <div> 2151 <div> 2152 </div> 2153 </div> 2154 </dl> 2155 </dd> 2156 2157 <!-- FUNCTION PARAMETERS --> 2158 <dd style="display: none; "> 2159 <div></div> 2160 </dd> 2161 2162 </div> 2163 </div> 2164 </dl> 2165 </dd> 2166 2167 <!-- FUNCTION PARAMETERS --> 2168 <dd style="display: none; "> 2169 <div></div> 2170 </dd> 2171 2172 </div> 2173 </div><div> 2174 <div> 2175 <dt> 2176 <var>callback</var> 2177 <em> 2178 2179 <!-- TYPE --> 2180 <div style="display:inline"> 2181 ( 2182 <span class="optional">optional</span> 2183 <span class="enum" style="display: none; ">enumerated</span> 2184 <span id="typeTemplate"> 2185 <span style="display: none; "> 2186 <a> Type</a> 2187 </span> 2188 <span> 2189 <span style="display: none; "> 2190 array of <span><span></span></span> 2191 </span> 2192 <span>function</span> 2193 <span style="display: none; "></span> 2194 </span> 2195 </span> 2196 ) 2197 </div> 2198 2199 </em> 2200 </dt> 2201 <dd class="todo" style="display: none; "> 2202 Undocumented. 2203 </dd> 2204 <dd>Called after all the JavaScript has been executed.</dd> 2205 <dd style="display: none; "> 2206 This parameter was added in version 2207 <b><span></span></b>. 2208 You must omit this parameter in earlier versions, 2209 and you may omit it in any version. If you require this 2210 parameter, the manifest key 2211 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2212 can ensure that your extension won't be run in an earlier browser version. 2213 </dd> 2214 2215 <!-- OBJECT PROPERTIES --> 2216 <dd style="display: none; "> 2217 <dl> 2218 <div> 2219 <div> 2220 </div> 2221 </div> 2222 </dl> 2223 </dd> 2224 2225 <!-- FUNCTION PARAMETERS --> 2226 <dd style="display: none; "> 2227 <div></div> 2228 </dd> 2229 2230 </div> 2231 </div> 2232 </dl> 2233 2234 <!-- RETURNS --> 2235 <h4 style="display: none; ">Returns</h4> 2236 <dl> 2237 <div style="display: none; "> 2238 <div> 2239 </div> 2240 </div> 2241 </dl> 2242 2243 <!-- CALLBACK --> 2244 <div> 2245 <div> 2246 <h4>Callback function</h4> 2247 <p style="display: none; "> 2248 The callback <em>parameter</em> should specify a function 2249 that looks like this: 2250 </p> 2251 <p> 2252 If you specify the <em>callback</em> parameter, it should 2253 specify a function that looks like this: 2254 </p> 2255 2256 <!-- Note: intentionally longer 80 columns --> 2257 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 2258 <dl> 2259 <div style="display: none; "> 2260 <div> 2261 </div> 2262 </div> 2263 </dl> 2264 </div> 2265 </div> 2266 2267 <!-- MIN_VERSION --> 2268 <p style="display: none; "> 2269 This function was added in version <b><span></span></b>. 2270 If you require this function, the manifest key 2271 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2272 can ensure that your extension won't be run in an earlier browser version. 2273 </p> 2274 </div> <!-- /description --> 2275 2276 </div><div class="apiItem"> 2277 <a name="method-get"></a> <!-- method-anchor --> 2278 <h4>get</h4> 2279 2280 <div class="summary"><span style="display: none; ">void</span> 2281 <!-- Note: intentionally longer 80 columns --> 2282 <span>chrome.tabs.get</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 2283 <var><span>tabId</span></var></span><span class="null"><span>, </span><span>function</span> 2284 <var><span>callback</span></var></span>)</div> 2285 2286 <div class="description"> 2287 <p class="todo" style="display: none; ">Undocumented.</p> 2288 <p>Retrieves details about the specified tab.</p> 2289 2290 <!-- PARAMETERS --> 2291 <h4>Parameters</h4> 2292 <dl> 2293 <div> 2294 <div> 2295 <dt> 2296 <var>tabId</var> 2297 <em> 2298 2299 <!-- TYPE --> 2300 <div style="display:inline"> 2301 ( 2302 <span class="optional" style="display: none; ">optional</span> 2303 <span class="enum" style="display: none; ">enumerated</span> 2304 <span id="typeTemplate"> 2305 <span style="display: none; "> 2306 <a> Type</a> 2307 </span> 2308 <span> 2309 <span style="display: none; "> 2310 array of <span><span></span></span> 2311 </span> 2312 <span>integer</span> 2313 <span style="display: none; "></span> 2314 </span> 2315 </span> 2316 ) 2317 </div> 2318 2319 </em> 2320 </dt> 2321 <dd class="todo"> 2322 Undocumented. 2323 </dd> 2324 <dd style="display: none; "> 2325 Description of this parameter from the json schema. 2326 </dd> 2327 <dd style="display: none; "> 2328 This parameter was added in version 2329 <b><span></span></b>. 2330 You must omit this parameter in earlier versions, 2331 and you may omit it in any version. If you require this 2332 parameter, the manifest key 2333 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2334 can ensure that your extension won't be run in an earlier browser version. 2335 </dd> 2336 2337 <!-- OBJECT PROPERTIES --> 2338 <dd style="display: none; "> 2339 <dl> 2340 <div> 2341 <div> 2342 </div> 2343 </div> 2344 </dl> 2345 </dd> 2346 2347 <!-- FUNCTION PARAMETERS --> 2348 <dd style="display: none; "> 2349 <div></div> 2350 </dd> 2351 2352 </div> 2353 </div><div> 2354 <div> 2355 <dt> 2356 <var>callback</var> 2357 <em> 2358 2359 <!-- TYPE --> 2360 <div style="display:inline"> 2361 ( 2362 <span class="optional" style="display: none; ">optional</span> 2363 <span class="enum" style="display: none; ">enumerated</span> 2364 <span id="typeTemplate"> 2365 <span style="display: none; "> 2366 <a> Type</a> 2367 </span> 2368 <span> 2369 <span style="display: none; "> 2370 array of <span><span></span></span> 2371 </span> 2372 <span>function</span> 2373 <span style="display: none; "></span> 2374 </span> 2375 </span> 2376 ) 2377 </div> 2378 2379 </em> 2380 </dt> 2381 <dd class="todo"> 2382 Undocumented. 2383 </dd> 2384 <dd style="display: none; "> 2385 Description of this parameter from the json schema. 2386 </dd> 2387 <dd style="display: none; "> 2388 This parameter was added in version 2389 <b><span></span></b>. 2390 You must omit this parameter in earlier versions, 2391 and you may omit it in any version. If you require this 2392 parameter, the manifest key 2393 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2394 can ensure that your extension won't be run in an earlier browser version. 2395 </dd> 2396 2397 <!-- OBJECT PROPERTIES --> 2398 <dd style="display: none; "> 2399 <dl> 2400 <div> 2401 <div> 2402 </div> 2403 </div> 2404 </dl> 2405 </dd> 2406 2407 <!-- FUNCTION PARAMETERS --> 2408 <dd style="display: none; "> 2409 <div></div> 2410 </dd> 2411 2412 </div> 2413 </div> 2414 </dl> 2415 2416 <!-- RETURNS --> 2417 <h4 style="display: none; ">Returns</h4> 2418 <dl> 2419 <div style="display: none; "> 2420 <div> 2421 </div> 2422 </div> 2423 </dl> 2424 2425 <!-- CALLBACK --> 2426 <div> 2427 <div> 2428 <h4>Callback function</h4> 2429 <p> 2430 The callback <em>parameter</em> should specify a function 2431 that looks like this: 2432 </p> 2433 <p style="display: none; "> 2434 If you specify the <em>callback</em> parameter, it should 2435 specify a function that looks like this: 2436 </p> 2437 2438 <!-- Note: intentionally longer 80 columns --> 2439 <pre>function(<span>Tab tab</span>) <span class="subdued">{...}</span>;</pre> 2440 <dl> 2441 <div> 2442 <div> 2443 <dt> 2444 <var>tab</var> 2445 <em> 2446 2447 <!-- TYPE --> 2448 <div style="display:inline"> 2449 ( 2450 <span class="optional" style="display: none; ">optional</span> 2451 <span class="enum" style="display: none; ">enumerated</span> 2452 <span id="typeTemplate"> 2453 <span> 2454 <a href="tabs.html#type-Tab">Tab</a> 2455 </span> 2456 <span style="display: none; "> 2457 <span> 2458 array of <span><span></span></span> 2459 </span> 2460 <span>paramType</span> 2461 <span></span> 2462 </span> 2463 </span> 2464 ) 2465 </div> 2466 2467 </em> 2468 </dt> 2469 <dd class="todo"> 2470 Undocumented. 2471 </dd> 2472 <dd style="display: none; "> 2473 Description of this parameter from the json schema. 2474 </dd> 2475 <dd style="display: none; "> 2476 This parameter was added in version 2477 <b><span></span></b>. 2478 You must omit this parameter in earlier versions, 2479 and you may omit it in any version. If you require this 2480 parameter, the manifest key 2481 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2482 can ensure that your extension won't be run in an earlier browser version. 2483 </dd> 2484 2485 <!-- OBJECT PROPERTIES --> 2486 <dd style="display: none; "> 2487 <dl> 2488 <div> 2489 <div> 2490 </div> 2491 </div> 2492 </dl> 2493 </dd> 2494 2495 <!-- FUNCTION PARAMETERS --> 2496 <dd style="display: none; "> 2497 <div></div> 2498 </dd> 2499 2500 </div> 2501 </div> 2502 </dl> 2503 </div> 2504 </div> 2505 2506 <!-- MIN_VERSION --> 2507 <p style="display: none; "> 2508 This function was added in version <b><span></span></b>. 2509 If you require this function, the manifest key 2510 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2511 can ensure that your extension won't be run in an earlier browser version. 2512 </p> 2513 </div> <!-- /description --> 2514 2515 </div><div class="apiItem"> 2516 <a name="method-getAllInWindow"></a> <!-- method-anchor --> 2517 <h4>getAllInWindow</h4> 2518 2519 <div class="summary"><span style="display: none; ">void</span> 2520 <!-- Note: intentionally longer 80 columns --> 2521 <span>chrome.tabs.getAllInWindow</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span> 2522 <var><span>windowId</span></var></span><span class="null"><span>, </span><span>function</span> 2523 <var><span>callback</span></var></span>)</div> 2524 2525 <div class="description"> 2526 <p class="todo" style="display: none; ">Undocumented.</p> 2527 <p>Gets details about all tabs in the specified window.</p> 2528 2529 <!-- PARAMETERS --> 2530 <h4>Parameters</h4> 2531 <dl> 2532 <div> 2533 <div> 2534 <dt> 2535 <var>windowId</var> 2536 <em> 2537 2538 <!-- TYPE --> 2539 <div style="display:inline"> 2540 ( 2541 <span class="optional">optional</span> 2542 <span class="enum" style="display: none; ">enumerated</span> 2543 <span id="typeTemplate"> 2544 <span style="display: none; "> 2545 <a> Type</a> 2546 </span> 2547 <span> 2548 <span style="display: none; "> 2549 array of <span><span></span></span> 2550 </span> 2551 <span>integer</span> 2552 <span style="display: none; "></span> 2553 </span> 2554 </span> 2555 ) 2556 </div> 2557 2558 </em> 2559 </dt> 2560 <dd class="todo" style="display: none; "> 2561 Undocumented. 2562 </dd> 2563 <dd>Defaults to the <a href="windows.html#current-window">current window</a>.</dd> 2564 <dd style="display: none; "> 2565 This parameter was added in version 2566 <b><span></span></b>. 2567 You must omit this parameter in earlier versions, 2568 and you may omit it in any version. If you require this 2569 parameter, the manifest key 2570 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2571 can ensure that your extension won't be run in an earlier browser version. 2572 </dd> 2573 2574 <!-- OBJECT PROPERTIES --> 2575 <dd style="display: none; "> 2576 <dl> 2577 <div> 2578 <div> 2579 </div> 2580 </div> 2581 </dl> 2582 </dd> 2583 2584 <!-- FUNCTION PARAMETERS --> 2585 <dd style="display: none; "> 2586 <div></div> 2587 </dd> 2588 2589 </div> 2590 </div><div> 2591 <div> 2592 <dt> 2593 <var>callback</var> 2594 <em> 2595 2596 <!-- TYPE --> 2597 <div style="display:inline"> 2598 ( 2599 <span class="optional" style="display: none; ">optional</span> 2600 <span class="enum" style="display: none; ">enumerated</span> 2601 <span id="typeTemplate"> 2602 <span style="display: none; "> 2603 <a> Type</a> 2604 </span> 2605 <span> 2606 <span style="display: none; "> 2607 array of <span><span></span></span> 2608 </span> 2609 <span>function</span> 2610 <span style="display: none; "></span> 2611 </span> 2612 </span> 2613 ) 2614 </div> 2615 2616 </em> 2617 </dt> 2618 <dd class="todo"> 2619 Undocumented. 2620 </dd> 2621 <dd style="display: none; "> 2622 Description of this parameter from the json schema. 2623 </dd> 2624 <dd style="display: none; "> 2625 This parameter was added in version 2626 <b><span></span></b>. 2627 You must omit this parameter in earlier versions, 2628 and you may omit it in any version. If you require this 2629 parameter, the manifest key 2630 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2631 can ensure that your extension won't be run in an earlier browser version. 2632 </dd> 2633 2634 <!-- OBJECT PROPERTIES --> 2635 <dd style="display: none; "> 2636 <dl> 2637 <div> 2638 <div> 2639 </div> 2640 </div> 2641 </dl> 2642 </dd> 2643 2644 <!-- FUNCTION PARAMETERS --> 2645 <dd style="display: none; "> 2646 <div></div> 2647 </dd> 2648 2649 </div> 2650 </div> 2651 </dl> 2652 2653 <!-- RETURNS --> 2654 <h4 style="display: none; ">Returns</h4> 2655 <dl> 2656 <div style="display: none; "> 2657 <div> 2658 </div> 2659 </div> 2660 </dl> 2661 2662 <!-- CALLBACK --> 2663 <div> 2664 <div> 2665 <h4>Callback function</h4> 2666 <p> 2667 The callback <em>parameter</em> should specify a function 2668 that looks like this: 2669 </p> 2670 <p style="display: none; "> 2671 If you specify the <em>callback</em> parameter, it should 2672 specify a function that looks like this: 2673 </p> 2674 2675 <!-- Note: intentionally longer 80 columns --> 2676 <pre>function(<span>array of Tab tabs</span>) <span class="subdued">{...}</span>;</pre> 2677 <dl> 2678 <div> 2679 <div> 2680 <dt> 2681 <var>tabs</var> 2682 <em> 2683 2684 <!-- TYPE --> 2685 <div style="display:inline"> 2686 ( 2687 <span class="optional" style="display: none; ">optional</span> 2688 <span class="enum" style="display: none; ">enumerated</span> 2689 <span id="typeTemplate"> 2690 <span style="display: none; "> 2691 <a> Type</a> 2692 </span> 2693 <span> 2694 <span> 2695 array of <span><span> 2696 <span> 2697 <a href="tabs.html#type-Tab">Tab</a> 2698 </span> 2699 <span style="display: none; "> 2700 <span> 2701 array of <span><span></span></span> 2702 </span> 2703 <span>paramType</span> 2704 <span></span> 2705 </span> 2706 </span></span> 2707 </span> 2708 <span style="display: none; ">paramType</span> 2709 <span style="display: none; "></span> 2710 </span> 2711 </span> 2712 ) 2713 </div> 2714 2715 </em> 2716 </dt> 2717 <dd class="todo"> 2718 Undocumented. 2719 </dd> 2720 <dd style="display: none; "> 2721 Description of this parameter from the json schema. 2722 </dd> 2723 <dd style="display: none; "> 2724 This parameter was added in version 2725 <b><span></span></b>. 2726 You must omit this parameter in earlier versions, 2727 and you may omit it in any version. If you require this 2728 parameter, the manifest key 2729 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2730 can ensure that your extension won't be run in an earlier browser version. 2731 </dd> 2732 2733 <!-- OBJECT PROPERTIES --> 2734 <dd style="display: none; "> 2735 <dl> 2736 <div> 2737 <div> 2738 </div> 2739 </div> 2740 </dl> 2741 </dd> 2742 2743 <!-- FUNCTION PARAMETERS --> 2744 <dd style="display: none; "> 2745 <div></div> 2746 </dd> 2747 2748 </div> 2749 </div> 2750 </dl> 2751 </div> 2752 </div> 2753 2754 <!-- MIN_VERSION --> 2755 <p style="display: none; "> 2756 This function was added in version <b><span></span></b>. 2757 If you require this function, the manifest key 2758 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2759 can ensure that your extension won't be run in an earlier browser version. 2760 </p> 2761 </div> <!-- /description --> 2762 2763 </div><div class="apiItem"> 2764 <a name="method-getCurrent"></a> <!-- method-anchor --> 2765 <h4>getCurrent</h4> 2766 2767 <div class="summary"><span style="display: none; ">void</span> 2768 <!-- Note: intentionally longer 80 columns --> 2769 <span>chrome.tabs.getCurrent</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> 2770 <var><span>callback</span></var></span>)</div> 2771 2772 <div class="description"> 2773 <p class="todo" style="display: none; ">Undocumented.</p> 2774 <p>Gets the tab that this script call is being made from. May be undefined if called from a non-tab context (for example: a background page or popup view).</p> 2775 2776 <!-- PARAMETERS --> 2777 <h4>Parameters</h4> 2778 <dl> 2779 <div> 2780 <div> 2781 <dt> 2782 <var>callback</var> 2783 <em> 2784 2785 <!-- TYPE --> 2786 <div style="display:inline"> 2787 ( 2788 <span class="optional" style="display: none; ">optional</span> 2789 <span class="enum" style="display: none; ">enumerated</span> 2790 <span id="typeTemplate"> 2791 <span style="display: none; "> 2792 <a> Type</a> 2793 </span> 2794 <span> 2795 <span style="display: none; "> 2796 array of <span><span></span></span> 2797 </span> 2798 <span>function</span> 2799 <span style="display: none; "></span> 2800 </span> 2801 </span> 2802 ) 2803 </div> 2804 2805 </em> 2806 </dt> 2807 <dd class="todo"> 2808 Undocumented. 2809 </dd> 2810 <dd style="display: none; "> 2811 Description of this parameter from the json schema. 2812 </dd> 2813 <dd style="display: none; "> 2814 This parameter was added in version 2815 <b><span></span></b>. 2816 You must omit this parameter in earlier versions, 2817 and you may omit it in any version. If you require this 2818 parameter, the manifest key 2819 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2820 can ensure that your extension won't be run in an earlier browser version. 2821 </dd> 2822 2823 <!-- OBJECT PROPERTIES --> 2824 <dd style="display: none; "> 2825 <dl> 2826 <div> 2827 <div> 2828 </div> 2829 </div> 2830 </dl> 2831 </dd> 2832 2833 <!-- FUNCTION PARAMETERS --> 2834 <dd style="display: none; "> 2835 <div></div> 2836 </dd> 2837 2838 </div> 2839 </div> 2840 </dl> 2841 2842 <!-- RETURNS --> 2843 <h4 style="display: none; ">Returns</h4> 2844 <dl> 2845 <div style="display: none; "> 2846 <div> 2847 </div> 2848 </div> 2849 </dl> 2850 2851 <!-- CALLBACK --> 2852 <div> 2853 <div> 2854 <h4>Callback function</h4> 2855 <p> 2856 The callback <em>parameter</em> should specify a function 2857 that looks like this: 2858 </p> 2859 <p style="display: none; "> 2860 If you specify the <em>callback</em> parameter, it should 2861 specify a function that looks like this: 2862 </p> 2863 2864 <!-- Note: intentionally longer 80 columns --> 2865 <pre>function(<span>Tab tab</span>) <span class="subdued">{...}</span>;</pre> 2866 <dl> 2867 <div> 2868 <div> 2869 <dt> 2870 <var>tab</var> 2871 <em> 2872 2873 <!-- TYPE --> 2874 <div style="display:inline"> 2875 ( 2876 <span class="optional">optional</span> 2877 <span class="enum" style="display: none; ">enumerated</span> 2878 <span id="typeTemplate"> 2879 <span> 2880 <a href="tabs.html#type-Tab">Tab</a> 2881 </span> 2882 <span style="display: none; "> 2883 <span> 2884 array of <span><span></span></span> 2885 </span> 2886 <span>paramType</span> 2887 <span></span> 2888 </span> 2889 </span> 2890 ) 2891 </div> 2892 2893 </em> 2894 </dt> 2895 <dd class="todo"> 2896 Undocumented. 2897 </dd> 2898 <dd style="display: none; "> 2899 Description of this parameter from the json schema. 2900 </dd> 2901 <dd style="display: none; "> 2902 This parameter was added in version 2903 <b><span></span></b>. 2904 You must omit this parameter in earlier versions, 2905 and you may omit it in any version. If you require this 2906 parameter, the manifest key 2907 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2908 can ensure that your extension won't be run in an earlier browser version. 2909 </dd> 2910 2911 <!-- OBJECT PROPERTIES --> 2912 <dd style="display: none; "> 2913 <dl> 2914 <div> 2915 <div> 2916 </div> 2917 </div> 2918 </dl> 2919 </dd> 2920 2921 <!-- FUNCTION PARAMETERS --> 2922 <dd style="display: none; "> 2923 <div></div> 2924 </dd> 2925 2926 </div> 2927 </div> 2928 </dl> 2929 </div> 2930 </div> 2931 2932 <!-- MIN_VERSION --> 2933 <p style="display: none; "> 2934 This function was added in version <b><span></span></b>. 2935 If you require this function, the manifest key 2936 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2937 can ensure that your extension won't be run in an earlier browser version. 2938 </p> 2939 </div> <!-- /description --> 2940 2941 </div><div class="apiItem"> 2942 <a name="method-getSelected"></a> <!-- method-anchor --> 2943 <h4>getSelected</h4> 2944 2945 <div class="summary"><span style="display: none; ">void</span> 2946 <!-- Note: intentionally longer 80 columns --> 2947 <span>chrome.tabs.getSelected</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span> 2948 <var><span>windowId</span></var></span><span class="null"><span>, </span><span>function</span> 2949 <var><span>callback</span></var></span>)</div> 2950 2951 <div class="description"> 2952 <p class="todo" style="display: none; ">Undocumented.</p> 2953 <p>Gets the tab that is selected in the specified window.</p> 2954 2955 <!-- PARAMETERS --> 2956 <h4>Parameters</h4> 2957 <dl> 2958 <div> 2959 <div> 2960 <dt> 2961 <var>windowId</var> 2962 <em> 2963 2964 <!-- TYPE --> 2965 <div style="display:inline"> 2966 ( 2967 <span class="optional">optional</span> 2968 <span class="enum" style="display: none; ">enumerated</span> 2969 <span id="typeTemplate"> 2970 <span style="display: none; "> 2971 <a> Type</a> 2972 </span> 2973 <span> 2974 <span style="display: none; "> 2975 array of <span><span></span></span> 2976 </span> 2977 <span>integer</span> 2978 <span style="display: none; "></span> 2979 </span> 2980 </span> 2981 ) 2982 </div> 2983 2984 </em> 2985 </dt> 2986 <dd class="todo" style="display: none; "> 2987 Undocumented. 2988 </dd> 2989 <dd>Defaults to the <a href="windows.html#current-window">current window</a>.</dd> 2990 <dd style="display: none; "> 2991 This parameter was added in version 2992 <b><span></span></b>. 2993 You must omit this parameter in earlier versions, 2994 and you may omit it in any version. If you require this 2995 parameter, the manifest key 2996 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2997 can ensure that your extension won't be run in an earlier browser version. 2998 </dd> 2999 3000 <!-- OBJECT PROPERTIES --> 3001 <dd style="display: none; "> 3002 <dl> 3003 <div> 3004 <div> 3005 </div> 3006 </div> 3007 </dl> 3008 </dd> 3009 3010 <!-- FUNCTION PARAMETERS --> 3011 <dd style="display: none; "> 3012 <div></div> 3013 </dd> 3014 3015 </div> 3016 </div><div> 3017 <div> 3018 <dt> 3019 <var>callback</var> 3020 <em> 3021 3022 <!-- TYPE --> 3023 <div style="display:inline"> 3024 ( 3025 <span class="optional" style="display: none; ">optional</span> 3026 <span class="enum" style="display: none; ">enumerated</span> 3027 <span id="typeTemplate"> 3028 <span style="display: none; "> 3029 <a> Type</a> 3030 </span> 3031 <span> 3032 <span style="display: none; "> 3033 array of <span><span></span></span> 3034 </span> 3035 <span>function</span> 3036 <span style="display: none; "></span> 3037 </span> 3038 </span> 3039 ) 3040 </div> 3041 3042 </em> 3043 </dt> 3044 <dd class="todo"> 3045 Undocumented. 3046 </dd> 3047 <dd style="display: none; "> 3048 Description of this parameter from the json schema. 3049 </dd> 3050 <dd style="display: none; "> 3051 This parameter was added in version 3052 <b><span></span></b>. 3053 You must omit this parameter in earlier versions, 3054 and you may omit it in any version. If you require this 3055 parameter, the manifest key 3056 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3057 can ensure that your extension won't be run in an earlier browser version. 3058 </dd> 3059 3060 <!-- OBJECT PROPERTIES --> 3061 <dd style="display: none; "> 3062 <dl> 3063 <div> 3064 <div> 3065 </div> 3066 </div> 3067 </dl> 3068 </dd> 3069 3070 <!-- FUNCTION PARAMETERS --> 3071 <dd style="display: none; "> 3072 <div></div> 3073 </dd> 3074 3075 </div> 3076 </div> 3077 </dl> 3078 3079 <!-- RETURNS --> 3080 <h4 style="display: none; ">Returns</h4> 3081 <dl> 3082 <div style="display: none; "> 3083 <div> 3084 </div> 3085 </div> 3086 </dl> 3087 3088 <!-- CALLBACK --> 3089 <div> 3090 <div> 3091 <h4>Callback function</h4> 3092 <p> 3093 The callback <em>parameter</em> should specify a function 3094 that looks like this: 3095 </p> 3096 <p style="display: none; "> 3097 If you specify the <em>callback</em> parameter, it should 3098 specify a function that looks like this: 3099 </p> 3100 3101 <!-- Note: intentionally longer 80 columns --> 3102 <pre>function(<span>Tab tab</span>) <span class="subdued">{...}</span>;</pre> 3103 <dl> 3104 <div> 3105 <div> 3106 <dt> 3107 <var>tab</var> 3108 <em> 3109 3110 <!-- TYPE --> 3111 <div style="display:inline"> 3112 ( 3113 <span class="optional" style="display: none; ">optional</span> 3114 <span class="enum" style="display: none; ">enumerated</span> 3115 <span id="typeTemplate"> 3116 <span> 3117 <a href="tabs.html#type-Tab">Tab</a> 3118 </span> 3119 <span style="display: none; "> 3120 <span> 3121 array of <span><span></span></span> 3122 </span> 3123 <span>paramType</span> 3124 <span></span> 3125 </span> 3126 </span> 3127 ) 3128 </div> 3129 3130 </em> 3131 </dt> 3132 <dd class="todo"> 3133 Undocumented. 3134 </dd> 3135 <dd style="display: none; "> 3136 Description of this parameter from the json schema. 3137 </dd> 3138 <dd style="display: none; "> 3139 This parameter was added in version 3140 <b><span></span></b>. 3141 You must omit this parameter in earlier versions, 3142 and you may omit it in any version. If you require this 3143 parameter, the manifest key 3144 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3145 can ensure that your extension won't be run in an earlier browser version. 3146 </dd> 3147 3148 <!-- OBJECT PROPERTIES --> 3149 <dd style="display: none; "> 3150 <dl> 3151 <div> 3152 <div> 3153 </div> 3154 </div> 3155 </dl> 3156 </dd> 3157 3158 <!-- FUNCTION PARAMETERS --> 3159 <dd style="display: none; "> 3160 <div></div> 3161 </dd> 3162 3163 </div> 3164 </div> 3165 </dl> 3166 </div> 3167 </div> 3168 3169 <!-- MIN_VERSION --> 3170 <p style="display: none; "> 3171 This function was added in version <b><span></span></b>. 3172 If you require this function, the manifest key 3173 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3174 can ensure that your extension won't be run in an earlier browser version. 3175 </p> 3176 </div> <!-- /description --> 3177 3178 </div><div class="apiItem"> 3179 <a name="method-insertCSS"></a> <!-- method-anchor --> 3180 <h4>insertCSS</h4> 3181 3182 <div class="summary"><span style="display: none; ">void</span> 3183 <!-- Note: intentionally longer 80 columns --> 3184 <span>chrome.tabs.insertCSS</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span> 3185 <var><span>tabId</span></var></span><span class="null"><span>, </span><span>object</span> 3186 <var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span> 3187 <var><span>callback</span></var></span>)</div> 3188 3189 <div class="description"> 3190 <p class="todo" style="display: none; ">Undocumented.</p> 3191 <p>Injects CSS into a page. For details, see the <a href="content_scripts.html#pi">programmatic injection</a> section of the content scripts doc.</p> 3192 3193 <!-- PARAMETERS --> 3194 <h4>Parameters</h4> 3195 <dl> 3196 <div> 3197 <div> 3198 <dt> 3199 <var>tabId</var> 3200 <em> 3201 3202 <!-- TYPE --> 3203 <div style="display:inline"> 3204 ( 3205 <span class="optional">optional</span> 3206 <span class="enum" style="display: none; ">enumerated</span> 3207 <span id="typeTemplate"> 3208 <span style="display: none; "> 3209 <a> Type</a> 3210 </span> 3211 <span> 3212 <span style="display: none; "> 3213 array of <span><span></span></span> 3214 </span> 3215 <span>integer</span> 3216 <span style="display: none; "></span> 3217 </span> 3218 </span> 3219 ) 3220 </div> 3221 3222 </em> 3223 </dt> 3224 <dd class="todo" style="display: none; "> 3225 Undocumented. 3226 </dd> 3227 <dd>The ID of the tab in which to insert the CSS; defaults to the selected tab of the current window.</dd> 3228 <dd style="display: none; "> 3229 This parameter was added in version 3230 <b><span></span></b>. 3231 You must omit this parameter in earlier versions, 3232 and you may omit it in any version. If you require this 3233 parameter, the manifest key 3234 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3235 can ensure that your extension won't be run in an earlier browser version. 3236 </dd> 3237 3238 <!-- OBJECT PROPERTIES --> 3239 <dd style="display: none; "> 3240 <dl> 3241 <div> 3242 <div> 3243 </div> 3244 </div> 3245 </dl> 3246 </dd> 3247 3248 <!-- FUNCTION PARAMETERS --> 3249 <dd style="display: none; "> 3250 <div></div> 3251 </dd> 3252 3253 </div> 3254 </div><div> 3255 <div> 3256 <dt> 3257 <var>details</var> 3258 <em> 3259 3260 <!-- TYPE --> 3261 <div style="display:inline"> 3262 ( 3263 <span class="optional" style="display: none; ">optional</span> 3264 <span class="enum" style="display: none; ">enumerated</span> 3265 <span id="typeTemplate"> 3266 <span style="display: none; "> 3267 <a> Type</a> 3268 </span> 3269 <span> 3270 <span style="display: none; "> 3271 array of <span><span></span></span> 3272 </span> 3273 <span>object</span> 3274 <span style="display: none; "></span> 3275 </span> 3276 </span> 3277 ) 3278 </div> 3279 3280 </em> 3281 </dt> 3282 <dd class="todo" style="display: none; "> 3283 Undocumented. 3284 </dd> 3285 <dd>Details of the CSS text to insert. Either the code or the file property must be set, but both may not be set at the same time.</dd> 3286 <dd style="display: none; "> 3287 This parameter was added in version 3288 <b><span></span></b>. 3289 You must omit this parameter in earlier versions, 3290 and you may omit it in any version. If you require this 3291 parameter, the manifest key 3292 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3293 can ensure that your extension won't be run in an earlier browser version. 3294 </dd> 3295 3296 <!-- OBJECT PROPERTIES --> 3297 <dd> 3298 <dl> 3299 <div> 3300 <div> 3301 <dt> 3302 <var>code</var> 3303 <em> 3304 3305 <!-- TYPE --> 3306 <div style="display:inline"> 3307 ( 3308 <span class="optional">optional</span> 3309 <span class="enum" style="display: none; ">enumerated</span> 3310 <span id="typeTemplate"> 3311 <span style="display: none; "> 3312 <a> Type</a> 3313 </span> 3314 <span> 3315 <span style="display: none; "> 3316 array of <span><span></span></span> 3317 </span> 3318 <span>string</span> 3319 <span style="display: none; "></span> 3320 </span> 3321 </span> 3322 ) 3323 </div> 3324 3325 </em> 3326 </dt> 3327 <dd class="todo" style="display: none; "> 3328 Undocumented. 3329 </dd> 3330 <dd>CSS code to be injected.</dd> 3331 <dd style="display: none; "> 3332 This parameter was added in version 3333 <b><span></span></b>. 3334 You must omit this parameter in earlier versions, 3335 and you may omit it in any version. If you require this 3336 parameter, the manifest key 3337 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3338 can ensure that your extension won't be run in an earlier browser version. 3339 </dd> 3340 3341 <!-- OBJECT PROPERTIES --> 3342 <dd style="display: none; "> 3343 <dl> 3344 <div> 3345 <div> 3346 </div> 3347 </div> 3348 </dl> 3349 </dd> 3350 3351 <!-- FUNCTION PARAMETERS --> 3352 <dd style="display: none; "> 3353 <div></div> 3354 </dd> 3355 3356 </div> 3357 </div><div> 3358 <div> 3359 <dt> 3360 <var>file</var> 3361 <em> 3362 3363 <!-- TYPE --> 3364 <div style="display:inline"> 3365 ( 3366 <span class="optional">optional</span> 3367 <span class="enum" style="display: none; ">enumerated</span> 3368 <span id="typeTemplate"> 3369 <span style="display: none; "> 3370 <a> Type</a> 3371 </span> 3372 <span> 3373 <span style="display: none; "> 3374 array of <span><span></span></span> 3375 </span> 3376 <span>string</span> 3377 <span style="display: none; "></span> 3378 </span> 3379 </span> 3380 ) 3381 </div> 3382 3383 </em> 3384 </dt> 3385 <dd class="todo" style="display: none; "> 3386 Undocumented. 3387 </dd> 3388 <dd>CSS file to be injected.</dd> 3389 <dd style="display: none; "> 3390 This parameter was added in version 3391 <b><span></span></b>. 3392 You must omit this parameter in earlier versions, 3393 and you may omit it in any version. If you require this 3394 parameter, the manifest key 3395 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3396 can ensure that your extension won't be run in an earlier browser version. 3397 </dd> 3398 3399 <!-- OBJECT PROPERTIES --> 3400 <dd style="display: none; "> 3401 <dl> 3402 <div> 3403 <div> 3404 </div> 3405 </div> 3406 </dl> 3407 </dd> 3408 3409 <!-- FUNCTION PARAMETERS --> 3410 <dd style="display: none; "> 3411 <div></div> 3412 </dd> 3413 3414 </div> 3415 </div><div> 3416 <div> 3417 <dt> 3418 <var>allFrames</var> 3419 <em> 3420 3421 <!-- TYPE --> 3422 <div style="display:inline"> 3423 ( 3424 <span class="optional">optional</span> 3425 <span class="enum" style="display: none; ">enumerated</span> 3426 <span id="typeTemplate"> 3427 <span style="display: none; "> 3428 <a> Type</a> 3429 </span> 3430 <span> 3431 <span style="display: none; "> 3432 array of <span><span></span></span> 3433 </span> 3434 <span>boolean</span> 3435 <span style="display: none; "></span> 3436 </span> 3437 </span> 3438 ) 3439 </div> 3440 3441 </em> 3442 </dt> 3443 <dd class="todo" style="display: none; "> 3444 Undocumented. 3445 </dd> 3446 <dd>If allFrames is true, this function injects CSS text into all frames of current page. By default, it's false and CSS is injected only into the top main frame.</dd> 3447 <dd style="display: none; "> 3448 This parameter was added in version 3449 <b><span></span></b>. 3450 You must omit this parameter in earlier versions, 3451 and you may omit it in any version. If you require this 3452 parameter, the manifest key 3453 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3454 can ensure that your extension won't be run in an earlier browser version. 3455 </dd> 3456 3457 <!-- OBJECT PROPERTIES --> 3458 <dd style="display: none; "> 3459 <dl> 3460 <div> 3461 <div> 3462 </div> 3463 </div> 3464 </dl> 3465 </dd> 3466 3467 <!-- FUNCTION PARAMETERS --> 3468 <dd style="display: none; "> 3469 <div></div> 3470 </dd> 3471 3472 </div> 3473 </div> 3474 </dl> 3475 </dd> 3476 3477 <!-- FUNCTION PARAMETERS --> 3478 <dd style="display: none; "> 3479 <div></div> 3480 </dd> 3481 3482 </div> 3483 </div><div> 3484 <div> 3485 <dt> 3486 <var>callback</var> 3487 <em> 3488 3489 <!-- TYPE --> 3490 <div style="display:inline"> 3491 ( 3492 <span class="optional">optional</span> 3493 <span class="enum" style="display: none; ">enumerated</span> 3494 <span id="typeTemplate"> 3495 <span style="display: none; "> 3496 <a> Type</a> 3497 </span> 3498 <span> 3499 <span style="display: none; "> 3500 array of <span><span></span></span> 3501 </span> 3502 <span>function</span> 3503 <span style="display: none; "></span> 3504 </span> 3505 </span> 3506 ) 3507 </div> 3508 3509 </em> 3510 </dt> 3511 <dd class="todo" style="display: none; "> 3512 Undocumented. 3513 </dd> 3514 <dd>Called when all the CSS has been inserted.</dd> 3515 <dd style="display: none; "> 3516 This parameter was added in version 3517 <b><span></span></b>. 3518 You must omit this parameter in earlier versions, 3519 and you may omit it in any version. If you require this 3520 parameter, the manifest key 3521 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3522 can ensure that your extension won't be run in an earlier browser version. 3523 </dd> 3524 3525 <!-- OBJECT PROPERTIES --> 3526 <dd style="display: none; "> 3527 <dl> 3528 <div> 3529 <div> 3530 </div> 3531 </div> 3532 </dl> 3533 </dd> 3534 3535 <!-- FUNCTION PARAMETERS --> 3536 <dd style="display: none; "> 3537 <div></div> 3538 </dd> 3539 3540 </div> 3541 </div> 3542 </dl> 3543 3544 <!-- RETURNS --> 3545 <h4 style="display: none; ">Returns</h4> 3546 <dl> 3547 <div style="display: none; "> 3548 <div> 3549 </div> 3550 </div> 3551 </dl> 3552 3553 <!-- CALLBACK --> 3554 <div> 3555 <div> 3556 <h4>Callback function</h4> 3557 <p style="display: none; "> 3558 The callback <em>parameter</em> should specify a function 3559 that looks like this: 3560 </p> 3561 <p> 3562 If you specify the <em>callback</em> parameter, it should 3563 specify a function that looks like this: 3564 </p> 3565 3566 <!-- Note: intentionally longer 80 columns --> 3567 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 3568 <dl> 3569 <div style="display: none; "> 3570 <div> 3571 </div> 3572 </div> 3573 </dl> 3574 </div> 3575 </div> 3576 3577 <!-- MIN_VERSION --> 3578 <p style="display: none; "> 3579 This function was added in version <b><span></span></b>. 3580 If you require this function, the manifest key 3581 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3582 can ensure that your extension won't be run in an earlier browser version. 3583 </p> 3584 </div> <!-- /description --> 3585 3586 </div><div class="apiItem"> 3587 <a name="method-move"></a> <!-- method-anchor --> 3588 <h4>move</h4> 3589 3590 <div class="summary"><span style="display: none; ">void</span> 3591 <!-- Note: intentionally longer 80 columns --> 3592 <span>chrome.tabs.move</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 3593 <var><span>tabId</span></var></span><span class="null"><span>, </span><span>object</span> 3594 <var><span>moveProperties</span></var></span><span class="optional"><span>, </span><span>function</span> 3595 <var><span>callback</span></var></span>)</div> 3596 3597 <div class="description"> 3598 <p class="todo" style="display: none; ">Undocumented.</p> 3599 <p>Moves a tab to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal (window.type === "normal") windows.</p> 3600 3601 <!-- PARAMETERS --> 3602 <h4>Parameters</h4> 3603 <dl> 3604 <div> 3605 <div> 3606 <dt> 3607 <var>tabId</var> 3608 <em> 3609 3610 <!-- TYPE --> 3611 <div style="display:inline"> 3612 ( 3613 <span class="optional" style="display: none; ">optional</span> 3614 <span class="enum" style="display: none; ">enumerated</span> 3615 <span id="typeTemplate"> 3616 <span style="display: none; "> 3617 <a> Type</a> 3618 </span> 3619 <span> 3620 <span style="display: none; "> 3621 array of <span><span></span></span> 3622 </span> 3623 <span>integer</span> 3624 <span style="display: none; "></span> 3625 </span> 3626 </span> 3627 ) 3628 </div> 3629 3630 </em> 3631 </dt> 3632 <dd class="todo"> 3633 Undocumented. 3634 </dd> 3635 <dd style="display: none; "> 3636 Description of this parameter from the json schema. 3637 </dd> 3638 <dd style="display: none; "> 3639 This parameter was added in version 3640 <b><span></span></b>. 3641 You must omit this parameter in earlier versions, 3642 and you may omit it in any version. If you require this 3643 parameter, the manifest key 3644 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3645 can ensure that your extension won't be run in an earlier browser version. 3646 </dd> 3647 3648 <!-- OBJECT PROPERTIES --> 3649 <dd style="display: none; "> 3650 <dl> 3651 <div> 3652 <div> 3653 </div> 3654 </div> 3655 </dl> 3656 </dd> 3657 3658 <!-- FUNCTION PARAMETERS --> 3659 <dd style="display: none; "> 3660 <div></div> 3661 </dd> 3662 3663 </div> 3664 </div><div> 3665 <div> 3666 <dt> 3667 <var>moveProperties</var> 3668 <em> 3669 3670 <!-- TYPE --> 3671 <div style="display:inline"> 3672 ( 3673 <span class="optional" style="display: none; ">optional</span> 3674 <span class="enum" style="display: none; ">enumerated</span> 3675 <span id="typeTemplate"> 3676 <span style="display: none; "> 3677 <a> Type</a> 3678 </span> 3679 <span> 3680 <span style="display: none; "> 3681 array of <span><span></span></span> 3682 </span> 3683 <span>object</span> 3684 <span style="display: none; "></span> 3685 </span> 3686 </span> 3687 ) 3688 </div> 3689 3690 </em> 3691 </dt> 3692 <dd class="todo"> 3693 Undocumented. 3694 </dd> 3695 <dd style="display: none; "> 3696 Description of this parameter from the json schema. 3697 </dd> 3698 <dd style="display: none; "> 3699 This parameter was added in version 3700 <b><span></span></b>. 3701 You must omit this parameter in earlier versions, 3702 and you may omit it in any version. If you require this 3703 parameter, the manifest key 3704 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3705 can ensure that your extension won't be run in an earlier browser version. 3706 </dd> 3707 3708 <!-- OBJECT PROPERTIES --> 3709 <dd> 3710 <dl> 3711 <div> 3712 <div> 3713 <dt> 3714 <var>windowId</var> 3715 <em> 3716 3717 <!-- TYPE --> 3718 <div style="display:inline"> 3719 ( 3720 <span class="optional">optional</span> 3721 <span class="enum" style="display: none; ">enumerated</span> 3722 <span id="typeTemplate"> 3723 <span style="display: none; "> 3724 <a> Type</a> 3725 </span> 3726 <span> 3727 <span style="display: none; "> 3728 array of <span><span></span></span> 3729 </span> 3730 <span>integer</span> 3731 <span style="display: none; "></span> 3732 </span> 3733 </span> 3734 ) 3735 </div> 3736 3737 </em> 3738 </dt> 3739 <dd class="todo" style="display: none; "> 3740 Undocumented. 3741 </dd> 3742 <dd>Defaults to the window the tab is currently in.</dd> 3743 <dd style="display: none; "> 3744 This parameter was added in version 3745 <b><span></span></b>. 3746 You must omit this parameter in earlier versions, 3747 and you may omit it in any version. If you require this 3748 parameter, the manifest key 3749 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3750 can ensure that your extension won't be run in an earlier browser version. 3751 </dd> 3752 3753 <!-- OBJECT PROPERTIES --> 3754 <dd style="display: none; "> 3755 <dl> 3756 <div> 3757 <div> 3758 </div> 3759 </div> 3760 </dl> 3761 </dd> 3762 3763 <!-- FUNCTION PARAMETERS --> 3764 <dd style="display: none; "> 3765 <div></div> 3766 </dd> 3767 3768 </div> 3769 </div><div> 3770 <div> 3771 <dt> 3772 <var>index</var> 3773 <em> 3774 3775 <!-- TYPE --> 3776 <div style="display:inline"> 3777 ( 3778 <span class="optional" style="display: none; ">optional</span> 3779 <span class="enum" style="display: none; ">enumerated</span> 3780 <span id="typeTemplate"> 3781 <span style="display: none; "> 3782 <a> Type</a> 3783 </span> 3784 <span> 3785 <span style="display: none; "> 3786 array of <span><span></span></span> 3787 </span> 3788 <span>integer</span> 3789 <span style="display: none; "></span> 3790 </span> 3791 </span> 3792 ) 3793 </div> 3794 3795 </em> 3796 </dt> 3797 <dd class="todo" style="display: none; "> 3798 Undocumented. 3799 </dd> 3800 <dd>The position to move the window to. The provided value will be clamped to between zero and the number of tabs in the window.</dd> 3801 <dd style="display: none; "> 3802 This parameter was added in version 3803 <b><span></span></b>. 3804 You must omit this parameter in earlier versions, 3805 and you may omit it in any version. If you require this 3806 parameter, the manifest key 3807 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3808 can ensure that your extension won't be run in an earlier browser version. 3809 </dd> 3810 3811 <!-- OBJECT PROPERTIES --> 3812 <dd style="display: none; "> 3813 <dl> 3814 <div> 3815 <div> 3816 </div> 3817 </div> 3818 </dl> 3819 </dd> 3820 3821 <!-- FUNCTION PARAMETERS --> 3822 <dd style="display: none; "> 3823 <div></div> 3824 </dd> 3825 3826 </div> 3827 </div> 3828 </dl> 3829 </dd> 3830 3831 <!-- FUNCTION PARAMETERS --> 3832 <dd style="display: none; "> 3833 <div></div> 3834 </dd> 3835 3836 </div> 3837 </div><div> 3838 <div> 3839 <dt> 3840 <var>callback</var> 3841 <em> 3842 3843 <!-- TYPE --> 3844 <div style="display:inline"> 3845 ( 3846 <span class="optional">optional</span> 3847 <span class="enum" style="display: none; ">enumerated</span> 3848 <span id="typeTemplate"> 3849 <span style="display: none; "> 3850 <a> Type</a> 3851 </span> 3852 <span> 3853 <span style="display: none; "> 3854 array of <span><span></span></span> 3855 </span> 3856 <span>function</span> 3857 <span style="display: none; "></span> 3858 </span> 3859 </span> 3860 ) 3861 </div> 3862 3863 </em> 3864 </dt> 3865 <dd class="todo"> 3866 Undocumented. 3867 </dd> 3868 <dd style="display: none; "> 3869 Description of this parameter from the json schema. 3870 </dd> 3871 <dd style="display: none; "> 3872 This parameter was added in version 3873 <b><span></span></b>. 3874 You must omit this parameter in earlier versions, 3875 and you may omit it in any version. If you require this 3876 parameter, the manifest key 3877 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3878 can ensure that your extension won't be run in an earlier browser version. 3879 </dd> 3880 3881 <!-- OBJECT PROPERTIES --> 3882 <dd style="display: none; "> 3883 <dl> 3884 <div> 3885 <div> 3886 </div> 3887 </div> 3888 </dl> 3889 </dd> 3890 3891 <!-- FUNCTION PARAMETERS --> 3892 <dd style="display: none; "> 3893 <div></div> 3894 </dd> 3895 3896 </div> 3897 </div> 3898 </dl> 3899 3900 <!-- RETURNS --> 3901 <h4 style="display: none; ">Returns</h4> 3902 <dl> 3903 <div style="display: none; "> 3904 <div> 3905 </div> 3906 </div> 3907 </dl> 3908 3909 <!-- CALLBACK --> 3910 <div> 3911 <div> 3912 <h4>Callback function</h4> 3913 <p style="display: none; "> 3914 The callback <em>parameter</em> should specify a function 3915 that looks like this: 3916 </p> 3917 <p> 3918 If you specify the <em>callback</em> parameter, it should 3919 specify a function that looks like this: 3920 </p> 3921 3922 <!-- Note: intentionally longer 80 columns --> 3923 <pre>function(<span>Tab tab</span>) <span class="subdued">{...}</span>;</pre> 3924 <dl> 3925 <div> 3926 <div> 3927 <dt> 3928 <var>tab</var> 3929 <em> 3930 3931 <!-- TYPE --> 3932 <div style="display:inline"> 3933 ( 3934 <span class="optional" style="display: none; ">optional</span> 3935 <span class="enum" style="display: none; ">enumerated</span> 3936 <span id="typeTemplate"> 3937 <span> 3938 <a href="tabs.html#type-Tab">Tab</a> 3939 </span> 3940 <span style="display: none; "> 3941 <span> 3942 array of <span><span></span></span> 3943 </span> 3944 <span>paramType</span> 3945 <span></span> 3946 </span> 3947 </span> 3948 ) 3949 </div> 3950 3951 </em> 3952 </dt> 3953 <dd class="todo" style="display: none; "> 3954 Undocumented. 3955 </dd> 3956 <dd>Details about the moved tab.</dd> 3957 <dd style="display: none; "> 3958 This parameter was added in version 3959 <b><span></span></b>. 3960 You must omit this parameter in earlier versions, 3961 and you may omit it in any version. If you require this 3962 parameter, the manifest key 3963 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3964 can ensure that your extension won't be run in an earlier browser version. 3965 </dd> 3966 3967 <!-- OBJECT PROPERTIES --> 3968 <dd style="display: none; "> 3969 <dl> 3970 <div> 3971 <div> 3972 </div> 3973 </div> 3974 </dl> 3975 </dd> 3976 3977 <!-- FUNCTION PARAMETERS --> 3978 <dd style="display: none; "> 3979 <div></div> 3980 </dd> 3981 3982 </div> 3983 </div> 3984 </dl> 3985 </div> 3986 </div> 3987 3988 <!-- MIN_VERSION --> 3989 <p style="display: none; "> 3990 This function was added in version <b><span></span></b>. 3991 If you require this function, the manifest key 3992 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 3993 can ensure that your extension won't be run in an earlier browser version. 3994 </p> 3995 </div> <!-- /description --> 3996 3997 </div><div class="apiItem"> 3998 <a name="method-remove"></a> <!-- method-anchor --> 3999 <h4>remove</h4> 4000 4001 <div class="summary"><span style="display: none; ">void</span> 4002 <!-- Note: intentionally longer 80 columns --> 4003 <span>chrome.tabs.remove</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 4004 <var><span>tabId</span></var></span><span class="optional"><span>, </span><span>function</span> 4005 <var><span>callback</span></var></span>)</div> 4006 4007 <div class="description"> 4008 <p class="todo" style="display: none; ">Undocumented.</p> 4009 <p>Closes a tab.</p> 4010 4011 <!-- PARAMETERS --> 4012 <h4>Parameters</h4> 4013 <dl> 4014 <div> 4015 <div> 4016 <dt> 4017 <var>tabId</var> 4018 <em> 4019 4020 <!-- TYPE --> 4021 <div style="display:inline"> 4022 ( 4023 <span class="optional" style="display: none; ">optional</span> 4024 <span class="enum" style="display: none; ">enumerated</span> 4025 <span id="typeTemplate"> 4026 <span style="display: none; "> 4027 <a> Type</a> 4028 </span> 4029 <span> 4030 <span style="display: none; "> 4031 array of <span><span></span></span> 4032 </span> 4033 <span>integer</span> 4034 <span style="display: none; "></span> 4035 </span> 4036 </span> 4037 ) 4038 </div> 4039 4040 </em> 4041 </dt> 4042 <dd class="todo"> 4043 Undocumented. 4044 </dd> 4045 <dd style="display: none; "> 4046 Description of this parameter from the json schema. 4047 </dd> 4048 <dd style="display: none; "> 4049 This parameter was added in version 4050 <b><span></span></b>. 4051 You must omit this parameter in earlier versions, 4052 and you may omit it in any version. If you require this 4053 parameter, the manifest key 4054 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4055 can ensure that your extension won't be run in an earlier browser version. 4056 </dd> 4057 4058 <!-- OBJECT PROPERTIES --> 4059 <dd style="display: none; "> 4060 <dl> 4061 <div> 4062 <div> 4063 </div> 4064 </div> 4065 </dl> 4066 </dd> 4067 4068 <!-- FUNCTION PARAMETERS --> 4069 <dd style="display: none; "> 4070 <div></div> 4071 </dd> 4072 4073 </div> 4074 </div><div> 4075 <div> 4076 <dt> 4077 <var>callback</var> 4078 <em> 4079 4080 <!-- TYPE --> 4081 <div style="display:inline"> 4082 ( 4083 <span class="optional">optional</span> 4084 <span class="enum" style="display: none; ">enumerated</span> 4085 <span id="typeTemplate"> 4086 <span style="display: none; "> 4087 <a> Type</a> 4088 </span> 4089 <span> 4090 <span style="display: none; "> 4091 array of <span><span></span></span> 4092 </span> 4093 <span>function</span> 4094 <span style="display: none; "></span> 4095 </span> 4096 </span> 4097 ) 4098 </div> 4099 4100 </em> 4101 </dt> 4102 <dd class="todo"> 4103 Undocumented. 4104 </dd> 4105 <dd style="display: none; "> 4106 Description of this parameter from the json schema. 4107 </dd> 4108 <dd style="display: none; "> 4109 This parameter was added in version 4110 <b><span></span></b>. 4111 You must omit this parameter in earlier versions, 4112 and you may omit it in any version. If you require this 4113 parameter, the manifest key 4114 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4115 can ensure that your extension won't be run in an earlier browser version. 4116 </dd> 4117 4118 <!-- OBJECT PROPERTIES --> 4119 <dd style="display: none; "> 4120 <dl> 4121 <div> 4122 <div> 4123 </div> 4124 </div> 4125 </dl> 4126 </dd> 4127 4128 <!-- FUNCTION PARAMETERS --> 4129 <dd style="display: none; "> 4130 <div></div> 4131 </dd> 4132 4133 </div> 4134 </div> 4135 </dl> 4136 4137 <!-- RETURNS --> 4138 <h4 style="display: none; ">Returns</h4> 4139 <dl> 4140 <div style="display: none; "> 4141 <div> 4142 </div> 4143 </div> 4144 </dl> 4145 4146 <!-- CALLBACK --> 4147 <div> 4148 <div> 4149 <h4>Callback function</h4> 4150 <p style="display: none; "> 4151 The callback <em>parameter</em> should specify a function 4152 that looks like this: 4153 </p> 4154 <p> 4155 If you specify the <em>callback</em> parameter, it should 4156 specify a function that looks like this: 4157 </p> 4158 4159 <!-- Note: intentionally longer 80 columns --> 4160 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 4161 <dl> 4162 <div style="display: none; "> 4163 <div> 4164 </div> 4165 </div> 4166 </dl> 4167 </div> 4168 </div> 4169 4170 <!-- MIN_VERSION --> 4171 <p style="display: none; "> 4172 This function was added in version <b><span></span></b>. 4173 If you require this function, the manifest key 4174 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4175 can ensure that your extension won't be run in an earlier browser version. 4176 </p> 4177 </div> <!-- /description --> 4178 4179 </div><div class="apiItem"> 4180 <a name="method-sendRequest"></a> <!-- method-anchor --> 4181 <h4>sendRequest</h4> 4182 4183 <div class="summary"><span style="display: none; ">void</span> 4184 <!-- Note: intentionally longer 80 columns --> 4185 <span>chrome.tabs.sendRequest</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 4186 <var><span>tabId</span></var></span><span class="null"><span>, </span><span>any</span> 4187 <var><span>request</span></var></span><span class="optional"><span>, </span><span>function</span> 4188 <var><span>responseCallback</span></var></span>)</div> 4189 4190 <div class="description"> 4191 <p class="todo" style="display: none; ">Undocumented.</p> 4192 <p>Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The <a href="extension.html#event-onRequest">chrome.extension.onRequest</a> event is fired in each content script running in the specified tab for the current extension.</p> 4193 4194 <!-- PARAMETERS --> 4195 <h4>Parameters</h4> 4196 <dl> 4197 <div> 4198 <div> 4199 <dt> 4200 <var>tabId</var> 4201 <em> 4202 4203 <!-- TYPE --> 4204 <div style="display:inline"> 4205 ( 4206 <span class="optional" style="display: none; ">optional</span> 4207 <span class="enum" style="display: none; ">enumerated</span> 4208 <span id="typeTemplate"> 4209 <span style="display: none; "> 4210 <a> Type</a> 4211 </span> 4212 <span> 4213 <span style="display: none; "> 4214 array of <span><span></span></span> 4215 </span> 4216 <span>integer</span> 4217 <span style="display: none; "></span> 4218 </span> 4219 </span> 4220 ) 4221 </div> 4222 4223 </em> 4224 </dt> 4225 <dd class="todo"> 4226 Undocumented. 4227 </dd> 4228 <dd style="display: none; "> 4229 Description of this parameter from the json schema. 4230 </dd> 4231 <dd style="display: none; "> 4232 This parameter was added in version 4233 <b><span></span></b>. 4234 You must omit this parameter in earlier versions, 4235 and you may omit it in any version. If you require this 4236 parameter, the manifest key 4237 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4238 can ensure that your extension won't be run in an earlier browser version. 4239 </dd> 4240 4241 <!-- OBJECT PROPERTIES --> 4242 <dd style="display: none; "> 4243 <dl> 4244 <div> 4245 <div> 4246 </div> 4247 </div> 4248 </dl> 4249 </dd> 4250 4251 <!-- FUNCTION PARAMETERS --> 4252 <dd style="display: none; "> 4253 <div></div> 4254 </dd> 4255 4256 </div> 4257 </div><div> 4258 <div> 4259 <dt> 4260 <var>request</var> 4261 <em> 4262 4263 <!-- TYPE --> 4264 <div style="display:inline"> 4265 ( 4266 <span class="optional" style="display: none; ">optional</span> 4267 <span class="enum" style="display: none; ">enumerated</span> 4268 <span id="typeTemplate"> 4269 <span style="display: none; "> 4270 <a> Type</a> 4271 </span> 4272 <span> 4273 <span style="display: none; "> 4274 array of <span><span></span></span> 4275 </span> 4276 <span>any</span> 4277 <span style="display: none; "></span> 4278 </span> 4279 </span> 4280 ) 4281 </div> 4282 4283 </em> 4284 </dt> 4285 <dd class="todo"> 4286 Undocumented. 4287 </dd> 4288 <dd style="display: none; "> 4289 Description of this parameter from the json schema. 4290 </dd> 4291 <dd style="display: none; "> 4292 This parameter was added in version 4293 <b><span></span></b>. 4294 You must omit this parameter in earlier versions, 4295 and you may omit it in any version. If you require this 4296 parameter, the manifest key 4297 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4298 can ensure that your extension won't be run in an earlier browser version. 4299 </dd> 4300 4301 <!-- OBJECT PROPERTIES --> 4302 <dd style="display: none; "> 4303 <dl> 4304 <div> 4305 <div> 4306 </div> 4307 </div> 4308 </dl> 4309 </dd> 4310 4311 <!-- FUNCTION PARAMETERS --> 4312 <dd style="display: none; "> 4313 <div></div> 4314 </dd> 4315 4316 </div> 4317 </div><div> 4318 <div> 4319 <dt> 4320 <var>responseCallback</var> 4321 <em> 4322 4323 <!-- TYPE --> 4324 <div style="display:inline"> 4325 ( 4326 <span class="optional">optional</span> 4327 <span class="enum" style="display: none; ">enumerated</span> 4328 <span id="typeTemplate"> 4329 <span style="display: none; "> 4330 <a> Type</a> 4331 </span> 4332 <span> 4333 <span style="display: none; "> 4334 array of <span><span></span></span> 4335 </span> 4336 <span>function</span> 4337 <span style="display: none; "></span> 4338 </span> 4339 </span> 4340 ) 4341 </div> 4342 4343 </em> 4344 </dt> 4345 <dd class="todo"> 4346 Undocumented. 4347 </dd> 4348 <dd style="display: none; "> 4349 Description of this parameter from the json schema. 4350 </dd> 4351 <dd style="display: none; "> 4352 This parameter was added in version 4353 <b><span></span></b>. 4354 You must omit this parameter in earlier versions, 4355 and you may omit it in any version. If you require this 4356 parameter, the manifest key 4357 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4358 can ensure that your extension won't be run in an earlier browser version. 4359 </dd> 4360 4361 <!-- OBJECT PROPERTIES --> 4362 <dd style="display: none; "> 4363 <dl> 4364 <div> 4365 <div> 4366 </div> 4367 </div> 4368 </dl> 4369 </dd> 4370 4371 <!-- FUNCTION PARAMETERS --> 4372 <dd> 4373 <div> 4374 <h5>Parameters</h5> 4375 <dl> 4376 <div> 4377 <div> 4378 <dt> 4379 <var>response</var> 4380 <em> 4381 4382 <!-- TYPE --> 4383 <div style="display:inline"> 4384 ( 4385 <span class="optional" style="display: none; ">optional</span> 4386 <span class="enum" style="display: none; ">enumerated</span> 4387 <span id="typeTemplate"> 4388 <span style="display: none; "> 4389 <a> Type</a> 4390 </span> 4391 <span> 4392 <span style="display: none; "> 4393 array of <span><span></span></span> 4394 </span> 4395 <span>any</span> 4396 <span style="display: none; "></span> 4397 </span> 4398 </span> 4399 ) 4400 </div> 4401 4402 </em> 4403 </dt> 4404 <dd class="todo" style="display: none; "> 4405 Undocumented. 4406 </dd> 4407 <dd>The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, 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> 4408 <dd style="display: none; "> 4409 This parameter was added in version 4410 <b><span></span></b>. 4411 You must omit this parameter in earlier versions, 4412 and you may omit it in any version. If you require this 4413 parameter, the manifest key 4414 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4415 can ensure that your extension won't be run in an earlier browser version. 4416 </dd> 4417 4418 <!-- OBJECT PROPERTIES --> 4419 <dd style="display: none; "> 4420 <dl> 4421 <div> 4422 <div> 4423 </div> 4424 </div> 4425 </dl> 4426 </dd> 4427 4428 <!-- FUNCTION PARAMETERS --> 4429 <dd style="display: none; "> 4430 <div></div> 4431 </dd> 4432 4433 </div> 4434 </div> 4435 </dl> 4436 </div> 4437 </dd> 4438 4439 </div> 4440 </div> 4441 </dl> 4442 4443 <!-- RETURNS --> 4444 <h4 style="display: none; ">Returns</h4> 4445 <dl> 4446 <div style="display: none; "> 4447 <div> 4448 </div> 4449 </div> 4450 </dl> 4451 4452 <!-- CALLBACK --> 4453 <div> 4454 <div> 4455 <h4>Callback function</h4> 4456 <p style="display: none; "> 4457 The callback <em>parameter</em> should specify a function 4458 that looks like this: 4459 </p> 4460 <p> 4461 If you specify the <em>callback</em> parameter, it should 4462 specify a function that looks like this: 4463 </p> 4464 4465 <!-- Note: intentionally longer 80 columns --> 4466 <pre>function(<span>any response</span>) <span class="subdued">{...}</span>;</pre> 4467 <dl> 4468 <div> 4469 <div> 4470 <dt> 4471 <var>response</var> 4472 <em> 4473 4474 <!-- TYPE --> 4475 <div style="display:inline"> 4476 ( 4477 <span class="optional" style="display: none; ">optional</span> 4478 <span class="enum" style="display: none; ">enumerated</span> 4479 <span id="typeTemplate"> 4480 <span style="display: none; "> 4481 <a> Type</a> 4482 </span> 4483 <span> 4484 <span style="display: none; "> 4485 array of <span><span></span></span> 4486 </span> 4487 <span>any</span> 4488 <span style="display: none; "></span> 4489 </span> 4490 </span> 4491 ) 4492 </div> 4493 4494 </em> 4495 </dt> 4496 <dd class="todo" style="display: none; "> 4497 Undocumented. 4498 </dd> 4499 <dd>The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, 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> 4500 <dd style="display: none; "> 4501 This parameter was added in version 4502 <b><span></span></b>. 4503 You must omit this parameter in earlier versions, 4504 and you may omit it in any version. If you require this 4505 parameter, the manifest key 4506 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4507 can ensure that your extension won't be run in an earlier browser version. 4508 </dd> 4509 4510 <!-- OBJECT PROPERTIES --> 4511 <dd style="display: none; "> 4512 <dl> 4513 <div> 4514 <div> 4515 </div> 4516 </div> 4517 </dl> 4518 </dd> 4519 4520 <!-- FUNCTION PARAMETERS --> 4521 <dd style="display: none; "> 4522 <div></div> 4523 </dd> 4524 4525 </div> 4526 </div> 4527 </dl> 4528 </div> 4529 </div> 4530 4531 <!-- MIN_VERSION --> 4532 <p style="display: none; "> 4533 This function was added in version <b><span></span></b>. 4534 If you require this function, the manifest key 4535 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4536 can ensure that your extension won't be run in an earlier browser version. 4537 </p> 4538 </div> <!-- /description --> 4539 4540 </div><div class="apiItem"> 4541 <a name="method-update"></a> <!-- method-anchor --> 4542 <h4>update</h4> 4543 4544 <div class="summary"><span style="display: none; ">void</span> 4545 <!-- Note: intentionally longer 80 columns --> 4546 <span>chrome.tabs.update</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 4547 <var><span>tabId</span></var></span><span class="null"><span>, </span><span>object</span> 4548 <var><span>updateProperties</span></var></span><span class="optional"><span>, </span><span>function</span> 4549 <var><span>callback</span></var></span>)</div> 4550 4551 <div class="description"> 4552 <p class="todo" style="display: none; ">Undocumented.</p> 4553 <p>Modifies the properties of a tab. Properties that are not specified in <var>updateProperties</var> are not modified. Note: This function can be used without requesting the 'tabs' permission in the manifest.</p> 4554 4555 <!-- PARAMETERS --> 4556 <h4>Parameters</h4> 4557 <dl> 4558 <div> 4559 <div> 4560 <dt> 4561 <var>tabId</var> 4562 <em> 4563 4564 <!-- TYPE --> 4565 <div style="display:inline"> 4566 ( 4567 <span class="optional" style="display: none; ">optional</span> 4568 <span class="enum" style="display: none; ">enumerated</span> 4569 <span id="typeTemplate"> 4570 <span style="display: none; "> 4571 <a> Type</a> 4572 </span> 4573 <span> 4574 <span style="display: none; "> 4575 array of <span><span></span></span> 4576 </span> 4577 <span>integer</span> 4578 <span style="display: none; "></span> 4579 </span> 4580 </span> 4581 ) 4582 </div> 4583 4584 </em> 4585 </dt> 4586 <dd class="todo"> 4587 Undocumented. 4588 </dd> 4589 <dd style="display: none; "> 4590 Description of this parameter from the json schema. 4591 </dd> 4592 <dd style="display: none; "> 4593 This parameter was added in version 4594 <b><span></span></b>. 4595 You must omit this parameter in earlier versions, 4596 and you may omit it in any version. If you require this 4597 parameter, the manifest key 4598 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4599 can ensure that your extension won't be run in an earlier browser version. 4600 </dd> 4601 4602 <!-- OBJECT PROPERTIES --> 4603 <dd style="display: none; "> 4604 <dl> 4605 <div> 4606 <div> 4607 </div> 4608 </div> 4609 </dl> 4610 </dd> 4611 4612 <!-- FUNCTION PARAMETERS --> 4613 <dd style="display: none; "> 4614 <div></div> 4615 </dd> 4616 4617 </div> 4618 </div><div> 4619 <div> 4620 <dt> 4621 <var>updateProperties</var> 4622 <em> 4623 4624 <!-- TYPE --> 4625 <div style="display:inline"> 4626 ( 4627 <span class="optional" style="display: none; ">optional</span> 4628 <span class="enum" style="display: none; ">enumerated</span> 4629 <span id="typeTemplate"> 4630 <span style="display: none; "> 4631 <a> Type</a> 4632 </span> 4633 <span> 4634 <span style="display: none; "> 4635 array of <span><span></span></span> 4636 </span> 4637 <span>object</span> 4638 <span style="display: none; "></span> 4639 </span> 4640 </span> 4641 ) 4642 </div> 4643 4644 </em> 4645 </dt> 4646 <dd class="todo"> 4647 Undocumented. 4648 </dd> 4649 <dd style="display: none; "> 4650 Description of this parameter from the json schema. 4651 </dd> 4652 <dd style="display: none; "> 4653 This parameter was added in version 4654 <b><span></span></b>. 4655 You must omit this parameter in earlier versions, 4656 and you may omit it in any version. If you require this 4657 parameter, the manifest key 4658 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4659 can ensure that your extension won't be run in an earlier browser version. 4660 </dd> 4661 4662 <!-- OBJECT PROPERTIES --> 4663 <dd> 4664 <dl> 4665 <div> 4666 <div> 4667 <dt> 4668 <var>url</var> 4669 <em> 4670 4671 <!-- TYPE --> 4672 <div style="display:inline"> 4673 ( 4674 <span class="optional">optional</span> 4675 <span class="enum" style="display: none; ">enumerated</span> 4676 <span id="typeTemplate"> 4677 <span style="display: none; "> 4678 <a> Type</a> 4679 </span> 4680 <span> 4681 <span style="display: none; "> 4682 array of <span><span></span></span> 4683 </span> 4684 <span>undefined</span> 4685 <span style="display: none; "></span> 4686 </span> 4687 </span> 4688 ) 4689 </div> 4690 4691 </em> 4692 </dt> 4693 <dd class="todo" style="display: none; "> 4694 Undocumented. 4695 </dd> 4696 <dd>A URL to navigate the tab to.</dd> 4697 <dd style="display: none; "> 4698 This parameter was added in version 4699 <b><span></span></b>. 4700 You must omit this parameter in earlier versions, 4701 and you may omit it in any version. If you require this 4702 parameter, the manifest key 4703 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4704 can ensure that your extension won't be run in an earlier browser version. 4705 </dd> 4706 4707 <!-- OBJECT PROPERTIES --> 4708 <dd style="display: none; "> 4709 <dl> 4710 <div> 4711 <div> 4712 </div> 4713 </div> 4714 </dl> 4715 </dd> 4716 4717 <!-- FUNCTION PARAMETERS --> 4718 <dd style="display: none; "> 4719 <div></div> 4720 </dd> 4721 4722 </div> 4723 </div><div> 4724 <div> 4725 <dt> 4726 <var>selected</var> 4727 <em> 4728 4729 <!-- TYPE --> 4730 <div style="display:inline"> 4731 ( 4732 <span class="optional">optional</span> 4733 <span class="enum" style="display: none; ">enumerated</span> 4734 <span id="typeTemplate"> 4735 <span style="display: none; "> 4736 <a> Type</a> 4737 </span> 4738 <span> 4739 <span style="display: none; "> 4740 array of <span><span></span></span> 4741 </span> 4742 <span>boolean</span> 4743 <span style="display: none; "></span> 4744 </span> 4745 </span> 4746 ) 4747 </div> 4748 4749 </em> 4750 </dt> 4751 <dd class="todo" style="display: none; "> 4752 Undocumented. 4753 </dd> 4754 <dd>Whether the tab should be selected.</dd> 4755 <dd style="display: none; "> 4756 This parameter was added in version 4757 <b><span></span></b>. 4758 You must omit this parameter in earlier versions, 4759 and you may omit it in any version. If you require this 4760 parameter, the manifest key 4761 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4762 can ensure that your extension won't be run in an earlier browser version. 4763 </dd> 4764 4765 <!-- OBJECT PROPERTIES --> 4766 <dd style="display: none; "> 4767 <dl> 4768 <div> 4769 <div> 4770 </div> 4771 </div> 4772 </dl> 4773 </dd> 4774 4775 <!-- FUNCTION PARAMETERS --> 4776 <dd style="display: none; "> 4777 <div></div> 4778 </dd> 4779 4780 </div> 4781 </div><div> 4782 <div> 4783 <dt> 4784 <var>pinned</var> 4785 <em> 4786 4787 <!-- TYPE --> 4788 <div style="display:inline"> 4789 ( 4790 <span class="optional">optional</span> 4791 <span class="enum" style="display: none; ">enumerated</span> 4792 <span id="typeTemplate"> 4793 <span style="display: none; "> 4794 <a> Type</a> 4795 </span> 4796 <span> 4797 <span style="display: none; "> 4798 array of <span><span></span></span> 4799 </span> 4800 <span>boolean</span> 4801 <span style="display: none; "></span> 4802 </span> 4803 </span> 4804 ) 4805 </div> 4806 4807 </em> 4808 </dt> 4809 <dd class="todo" style="display: none; "> 4810 Undocumented. 4811 </dd> 4812 <dd>Whether the tab should be pinned.</dd> 4813 <dd style="display: none; "> 4814 This parameter was added in version 4815 <b><span></span></b>. 4816 You must omit this parameter in earlier versions, 4817 and you may omit it in any version. If you require this 4818 parameter, the manifest key 4819 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4820 can ensure that your extension won't be run in an earlier browser version. 4821 </dd> 4822 4823 <!-- OBJECT PROPERTIES --> 4824 <dd style="display: none; "> 4825 <dl> 4826 <div> 4827 <div> 4828 </div> 4829 </div> 4830 </dl> 4831 </dd> 4832 4833 <!-- FUNCTION PARAMETERS --> 4834 <dd style="display: none; "> 4835 <div></div> 4836 </dd> 4837 4838 </div> 4839 </div> 4840 </dl> 4841 </dd> 4842 4843 <!-- FUNCTION PARAMETERS --> 4844 <dd style="display: none; "> 4845 <div></div> 4846 </dd> 4847 4848 </div> 4849 </div><div> 4850 <div> 4851 <dt> 4852 <var>callback</var> 4853 <em> 4854 4855 <!-- TYPE --> 4856 <div style="display:inline"> 4857 ( 4858 <span class="optional">optional</span> 4859 <span class="enum" style="display: none; ">enumerated</span> 4860 <span id="typeTemplate"> 4861 <span style="display: none; "> 4862 <a> Type</a> 4863 </span> 4864 <span> 4865 <span style="display: none; "> 4866 array of <span><span></span></span> 4867 </span> 4868 <span>function</span> 4869 <span style="display: none; "></span> 4870 </span> 4871 </span> 4872 ) 4873 </div> 4874 4875 </em> 4876 </dt> 4877 <dd class="todo"> 4878 Undocumented. 4879 </dd> 4880 <dd style="display: none; "> 4881 Description of this parameter from the json schema. 4882 </dd> 4883 <dd style="display: none; "> 4884 This parameter was added in version 4885 <b><span></span></b>. 4886 You must omit this parameter in earlier versions, 4887 and you may omit it in any version. If you require this 4888 parameter, the manifest key 4889 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4890 can ensure that your extension won't be run in an earlier browser version. 4891 </dd> 4892 4893 <!-- OBJECT PROPERTIES --> 4894 <dd style="display: none; "> 4895 <dl> 4896 <div> 4897 <div> 4898 </div> 4899 </div> 4900 </dl> 4901 </dd> 4902 4903 <!-- FUNCTION PARAMETERS --> 4904 <dd style="display: none; "> 4905 <div></div> 4906 </dd> 4907 4908 </div> 4909 </div> 4910 </dl> 4911 4912 <!-- RETURNS --> 4913 <h4 style="display: none; ">Returns</h4> 4914 <dl> 4915 <div style="display: none; "> 4916 <div> 4917 </div> 4918 </div> 4919 </dl> 4920 4921 <!-- CALLBACK --> 4922 <div> 4923 <div> 4924 <h4>Callback function</h4> 4925 <p style="display: none; "> 4926 The callback <em>parameter</em> should specify a function 4927 that looks like this: 4928 </p> 4929 <p> 4930 If you specify the <em>callback</em> parameter, it should 4931 specify a function that looks like this: 4932 </p> 4933 4934 <!-- Note: intentionally longer 80 columns --> 4935 <pre>function(<span>Tab tab</span>) <span class="subdued">{...}</span>;</pre> 4936 <dl> 4937 <div> 4938 <div> 4939 <dt> 4940 <var>tab</var> 4941 <em> 4942 4943 <!-- TYPE --> 4944 <div style="display:inline"> 4945 ( 4946 <span class="optional" style="display: none; ">optional</span> 4947 <span class="enum" style="display: none; ">enumerated</span> 4948 <span id="typeTemplate"> 4949 <span> 4950 <a href="tabs.html#type-Tab">Tab</a> 4951 </span> 4952 <span style="display: none; "> 4953 <span> 4954 array of <span><span></span></span> 4955 </span> 4956 <span>paramType</span> 4957 <span></span> 4958 </span> 4959 </span> 4960 ) 4961 </div> 4962 4963 </em> 4964 </dt> 4965 <dd class="todo" style="display: none; "> 4966 Undocumented. 4967 </dd> 4968 <dd>Details about the updated tab.</dd> 4969 <dd style="display: none; "> 4970 This parameter was added in version 4971 <b><span></span></b>. 4972 You must omit this parameter in earlier versions, 4973 and you may omit it in any version. If you require this 4974 parameter, the manifest key 4975 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 4976 can ensure that your extension won't be run in an earlier browser version. 4977 </dd> 4978 4979 <!-- OBJECT PROPERTIES --> 4980 <dd style="display: none; "> 4981 <dl> 4982 <div> 4983 <div> 4984 </div> 4985 </div> 4986 </dl> 4987 </dd> 4988 4989 <!-- FUNCTION PARAMETERS --> 4990 <dd style="display: none; "> 4991 <div></div> 4992 </dd> 4993 4994 </div> 4995 </div> 4996 </dl> 4997 </div> 4998 </div> 4999 5000 <!-- MIN_VERSION --> 5001 <p style="display: none; "> 5002 This function was added in version <b><span></span></b>. 5003 If you require this function, the manifest key 5004 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5005 can ensure that your extension won't be run in an earlier browser version. 5006 </p> 5007 </div> <!-- /description --> 5008 5009 </div> <!-- /apiItem --> 5010 5011 </div> <!-- /apiGroup --> 5012 5013 <!-- EVENTS --> 5014 <div class="apiGroup"> 5015 <a name="events"></a> 5016 <h3 id="events">Events</h3> 5017 5018 <!-- iterates over all events --> 5019 <div class="apiItem"> 5020 <a name="event-onAttached"></a> 5021 <h4>onAttached</h4> 5022 5023 <div class="summary"> 5024 <!-- Note: intentionally longer 80 columns --> 5025 <span class="subdued">chrome.tabs.</span><span>onAttached</span><span class="subdued">.addListener</span>(function(<span>integer tabId, object attachInfo</span>) <span class="subdued">{...}</span>); 5026 </div> 5027 5028 <div class="description"> 5029 <p class="todo" style="display: none; ">Undocumented.</p> 5030 <p>Fired when a tab is attached to a window, for example because it was moved between windows.</p> 5031 5032 <!-- PARAMETERS --> 5033 <h4>Parameters</h4> 5034 <dl> 5035 <div> 5036 <div> 5037 <dt> 5038 <var>tabId</var> 5039 <em> 5040 5041 <!-- TYPE --> 5042 <div style="display:inline"> 5043 ( 5044 <span class="optional" style="display: none; ">optional</span> 5045 <span class="enum" style="display: none; ">enumerated</span> 5046 <span id="typeTemplate"> 5047 <span style="display: none; "> 5048 <a> Type</a> 5049 </span> 5050 <span> 5051 <span style="display: none; "> 5052 array of <span><span></span></span> 5053 </span> 5054 <span>integer</span> 5055 <span style="display: none; "></span> 5056 </span> 5057 </span> 5058 ) 5059 </div> 5060 5061 </em> 5062 </dt> 5063 <dd class="todo"> 5064 Undocumented. 5065 </dd> 5066 <dd style="display: none; "> 5067 Description of this parameter from the json schema. 5068 </dd> 5069 <dd style="display: none; "> 5070 This parameter was added in version 5071 <b><span></span></b>. 5072 You must omit this parameter in earlier versions, 5073 and you may omit it in any version. If you require this 5074 parameter, the manifest key 5075 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5076 can ensure that your extension won't be run in an earlier browser version. 5077 </dd> 5078 5079 <!-- OBJECT PROPERTIES --> 5080 <dd style="display: none; "> 5081 <dl> 5082 <div> 5083 <div> 5084 </div> 5085 </div> 5086 </dl> 5087 </dd> 5088 5089 <!-- FUNCTION PARAMETERS --> 5090 <dd style="display: none; "> 5091 <div></div> 5092 </dd> 5093 5094 </div> 5095 </div><div> 5096 <div> 5097 <dt> 5098 <var>attachInfo</var> 5099 <em> 5100 5101 <!-- TYPE --> 5102 <div style="display:inline"> 5103 ( 5104 <span class="optional" style="display: none; ">optional</span> 5105 <span class="enum" style="display: none; ">enumerated</span> 5106 <span id="typeTemplate"> 5107 <span style="display: none; "> 5108 <a> Type</a> 5109 </span> 5110 <span> 5111 <span style="display: none; "> 5112 array of <span><span></span></span> 5113 </span> 5114 <span>object</span> 5115 <span style="display: none; "></span> 5116 </span> 5117 </span> 5118 ) 5119 </div> 5120 5121 </em> 5122 </dt> 5123 <dd class="todo"> 5124 Undocumented. 5125 </dd> 5126 <dd style="display: none; "> 5127 Description of this parameter from the json schema. 5128 </dd> 5129 <dd style="display: none; "> 5130 This parameter was added in version 5131 <b><span></span></b>. 5132 You must omit this parameter in earlier versions, 5133 and you may omit it in any version. If you require this 5134 parameter, the manifest key 5135 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5136 can ensure that your extension won't be run in an earlier browser version. 5137 </dd> 5138 5139 <!-- OBJECT PROPERTIES --> 5140 <dd> 5141 <dl> 5142 <div> 5143 <div> 5144 <dt> 5145 <var>newWindowId</var> 5146 <em> 5147 5148 <!-- TYPE --> 5149 <div style="display:inline"> 5150 ( 5151 <span class="optional" style="display: none; ">optional</span> 5152 <span class="enum" style="display: none; ">enumerated</span> 5153 <span id="typeTemplate"> 5154 <span style="display: none; "> 5155 <a> Type</a> 5156 </span> 5157 <span> 5158 <span style="display: none; "> 5159 array of <span><span></span></span> 5160 </span> 5161 <span>integer</span> 5162 <span style="display: none; "></span> 5163 </span> 5164 </span> 5165 ) 5166 </div> 5167 5168 </em> 5169 </dt> 5170 <dd class="todo"> 5171 Undocumented. 5172 </dd> 5173 <dd style="display: none; "> 5174 Description of this parameter from the json schema. 5175 </dd> 5176 <dd style="display: none; "> 5177 This parameter was added in version 5178 <b><span></span></b>. 5179 You must omit this parameter in earlier versions, 5180 and you may omit it in any version. If you require this 5181 parameter, the manifest key 5182 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5183 can ensure that your extension won't be run in an earlier browser version. 5184 </dd> 5185 5186 <!-- OBJECT PROPERTIES --> 5187 <dd style="display: none; "> 5188 <dl> 5189 <div> 5190 <div> 5191 </div> 5192 </div> 5193 </dl> 5194 </dd> 5195 5196 <!-- FUNCTION PARAMETERS --> 5197 <dd style="display: none; "> 5198 <div></div> 5199 </dd> 5200 5201 </div> 5202 </div><div> 5203 <div> 5204 <dt> 5205 <var>newPosition</var> 5206 <em> 5207 5208 <!-- TYPE --> 5209 <div style="display:inline"> 5210 ( 5211 <span class="optional" style="display: none; ">optional</span> 5212 <span class="enum" style="display: none; ">enumerated</span> 5213 <span id="typeTemplate"> 5214 <span style="display: none; "> 5215 <a> Type</a> 5216 </span> 5217 <span> 5218 <span style="display: none; "> 5219 array of <span><span></span></span> 5220 </span> 5221 <span>integer</span> 5222 <span style="display: none; "></span> 5223 </span> 5224 </span> 5225 ) 5226 </div> 5227 5228 </em> 5229 </dt> 5230 <dd class="todo"> 5231 Undocumented. 5232 </dd> 5233 <dd style="display: none; "> 5234 Description of this parameter from the json schema. 5235 </dd> 5236 <dd style="display: none; "> 5237 This parameter was added in version 5238 <b><span></span></b>. 5239 You must omit this parameter in earlier versions, 5240 and you may omit it in any version. If you require this 5241 parameter, the manifest key 5242 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5243 can ensure that your extension won't be run in an earlier browser version. 5244 </dd> 5245 5246 <!-- OBJECT PROPERTIES --> 5247 <dd style="display: none; "> 5248 <dl> 5249 <div> 5250 <div> 5251 </div> 5252 </div> 5253 </dl> 5254 </dd> 5255 5256 <!-- FUNCTION PARAMETERS --> 5257 <dd style="display: none; "> 5258 <div></div> 5259 </dd> 5260 5261 </div> 5262 </div> 5263 </dl> 5264 </dd> 5265 5266 <!-- FUNCTION PARAMETERS --> 5267 <dd style="display: none; "> 5268 <div></div> 5269 </dd> 5270 5271 </div> 5272 </div> 5273 </dl> 5274 5275 </div> <!-- /decription --> 5276 5277 </div><div class="apiItem"> 5278 <a name="event-onCreated"></a> 5279 <h4>onCreated</h4> 5280 5281 <div class="summary"> 5282 <!-- Note: intentionally longer 80 columns --> 5283 <span class="subdued">chrome.tabs.</span><span>onCreated</span><span class="subdued">.addListener</span>(function(<span>Tab tab</span>) <span class="subdued">{...}</span>); 5284 </div> 5285 5286 <div class="description"> 5287 <p class="todo" style="display: none; ">Undocumented.</p> 5288 <p>Fires when a tab is created.</p> 5289 5290 <!-- PARAMETERS --> 5291 <h4>Parameters</h4> 5292 <dl> 5293 <div> 5294 <div> 5295 <dt> 5296 <var>tab</var> 5297 <em> 5298 5299 <!-- TYPE --> 5300 <div style="display:inline"> 5301 ( 5302 <span class="optional" style="display: none; ">optional</span> 5303 <span class="enum" style="display: none; ">enumerated</span> 5304 <span id="typeTemplate"> 5305 <span> 5306 <a href="tabs.html#type-Tab">Tab</a> 5307 </span> 5308 <span style="display: none; "> 5309 <span> 5310 array of <span><span></span></span> 5311 </span> 5312 <span>paramType</span> 5313 <span></span> 5314 </span> 5315 </span> 5316 ) 5317 </div> 5318 5319 </em> 5320 </dt> 5321 <dd class="todo" style="display: none; "> 5322 Undocumented. 5323 </dd> 5324 <dd>Details of the tab that was created.</dd> 5325 <dd style="display: none; "> 5326 This parameter was added in version 5327 <b><span></span></b>. 5328 You must omit this parameter in earlier versions, 5329 and you may omit it in any version. If you require this 5330 parameter, the manifest key 5331 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5332 can ensure that your extension won't be run in an earlier browser version. 5333 </dd> 5334 5335 <!-- OBJECT PROPERTIES --> 5336 <dd style="display: none; "> 5337 <dl> 5338 <div> 5339 <div> 5340 </div> 5341 </div> 5342 </dl> 5343 </dd> 5344 5345 <!-- FUNCTION PARAMETERS --> 5346 <dd style="display: none; "> 5347 <div></div> 5348 </dd> 5349 5350 </div> 5351 </div> 5352 </dl> 5353 5354 </div> <!-- /decription --> 5355 5356 </div><div class="apiItem"> 5357 <a name="event-onDetached"></a> 5358 <h4>onDetached</h4> 5359 5360 <div class="summary"> 5361 <!-- Note: intentionally longer 80 columns --> 5362 <span class="subdued">chrome.tabs.</span><span>onDetached</span><span class="subdued">.addListener</span>(function(<span>integer tabId, object detachInfo</span>) <span class="subdued">{...}</span>); 5363 </div> 5364 5365 <div class="description"> 5366 <p class="todo" style="display: none; ">Undocumented.</p> 5367 <p>Fired when a tab is detached from a window, for example because it is being moved between windows.</p> 5368 5369 <!-- PARAMETERS --> 5370 <h4>Parameters</h4> 5371 <dl> 5372 <div> 5373 <div> 5374 <dt> 5375 <var>tabId</var> 5376 <em> 5377 5378 <!-- TYPE --> 5379 <div style="display:inline"> 5380 ( 5381 <span class="optional" style="display: none; ">optional</span> 5382 <span class="enum" style="display: none; ">enumerated</span> 5383 <span id="typeTemplate"> 5384 <span style="display: none; "> 5385 <a> Type</a> 5386 </span> 5387 <span> 5388 <span style="display: none; "> 5389 array of <span><span></span></span> 5390 </span> 5391 <span>integer</span> 5392 <span style="display: none; "></span> 5393 </span> 5394 </span> 5395 ) 5396 </div> 5397 5398 </em> 5399 </dt> 5400 <dd class="todo"> 5401 Undocumented. 5402 </dd> 5403 <dd style="display: none; "> 5404 Description of this parameter from the json schema. 5405 </dd> 5406 <dd style="display: none; "> 5407 This parameter was added in version 5408 <b><span></span></b>. 5409 You must omit this parameter in earlier versions, 5410 and you may omit it in any version. If you require this 5411 parameter, the manifest key 5412 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5413 can ensure that your extension won't be run in an earlier browser version. 5414 </dd> 5415 5416 <!-- OBJECT PROPERTIES --> 5417 <dd style="display: none; "> 5418 <dl> 5419 <div> 5420 <div> 5421 </div> 5422 </div> 5423 </dl> 5424 </dd> 5425 5426 <!-- FUNCTION PARAMETERS --> 5427 <dd style="display: none; "> 5428 <div></div> 5429 </dd> 5430 5431 </div> 5432 </div><div> 5433 <div> 5434 <dt> 5435 <var>detachInfo</var> 5436 <em> 5437 5438 <!-- TYPE --> 5439 <div style="display:inline"> 5440 ( 5441 <span class="optional" style="display: none; ">optional</span> 5442 <span class="enum" style="display: none; ">enumerated</span> 5443 <span id="typeTemplate"> 5444 <span style="display: none; "> 5445 <a> Type</a> 5446 </span> 5447 <span> 5448 <span style="display: none; "> 5449 array of <span><span></span></span> 5450 </span> 5451 <span>object</span> 5452 <span style="display: none; "></span> 5453 </span> 5454 </span> 5455 ) 5456 </div> 5457 5458 </em> 5459 </dt> 5460 <dd class="todo"> 5461 Undocumented. 5462 </dd> 5463 <dd style="display: none; "> 5464 Description of this parameter from the json schema. 5465 </dd> 5466 <dd style="display: none; "> 5467 This parameter was added in version 5468 <b><span></span></b>. 5469 You must omit this parameter in earlier versions, 5470 and you may omit it in any version. If you require this 5471 parameter, the manifest key 5472 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5473 can ensure that your extension won't be run in an earlier browser version. 5474 </dd> 5475 5476 <!-- OBJECT PROPERTIES --> 5477 <dd> 5478 <dl> 5479 <div> 5480 <div> 5481 <dt> 5482 <var>oldWindowId</var> 5483 <em> 5484 5485 <!-- TYPE --> 5486 <div style="display:inline"> 5487 ( 5488 <span class="optional" style="display: none; ">optional</span> 5489 <span class="enum" style="display: none; ">enumerated</span> 5490 <span id="typeTemplate"> 5491 <span style="display: none; "> 5492 <a> Type</a> 5493 </span> 5494 <span> 5495 <span style="display: none; "> 5496 array of <span><span></span></span> 5497 </span> 5498 <span>integer</span> 5499 <span style="display: none; "></span> 5500 </span> 5501 </span> 5502 ) 5503 </div> 5504 5505 </em> 5506 </dt> 5507 <dd class="todo"> 5508 Undocumented. 5509 </dd> 5510 <dd style="display: none; "> 5511 Description of this parameter from the json schema. 5512 </dd> 5513 <dd style="display: none; "> 5514 This parameter was added in version 5515 <b><span></span></b>. 5516 You must omit this parameter in earlier versions, 5517 and you may omit it in any version. If you require this 5518 parameter, the manifest key 5519 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5520 can ensure that your extension won't be run in an earlier browser version. 5521 </dd> 5522 5523 <!-- OBJECT PROPERTIES --> 5524 <dd style="display: none; "> 5525 <dl> 5526 <div> 5527 <div> 5528 </div> 5529 </div> 5530 </dl> 5531 </dd> 5532 5533 <!-- FUNCTION PARAMETERS --> 5534 <dd style="display: none; "> 5535 <div></div> 5536 </dd> 5537 5538 </div> 5539 </div><div> 5540 <div> 5541 <dt> 5542 <var>oldPosition</var> 5543 <em> 5544 5545 <!-- TYPE --> 5546 <div style="display:inline"> 5547 ( 5548 <span class="optional" style="display: none; ">optional</span> 5549 <span class="enum" style="display: none; ">enumerated</span> 5550 <span id="typeTemplate"> 5551 <span style="display: none; "> 5552 <a> Type</a> 5553 </span> 5554 <span> 5555 <span style="display: none; "> 5556 array of <span><span></span></span> 5557 </span> 5558 <span>integer</span> 5559 <span style="display: none; "></span> 5560 </span> 5561 </span> 5562 ) 5563 </div> 5564 5565 </em> 5566 </dt> 5567 <dd class="todo"> 5568 Undocumented. 5569 </dd> 5570 <dd style="display: none; "> 5571 Description of this parameter from the json schema. 5572 </dd> 5573 <dd style="display: none; "> 5574 This parameter was added in version 5575 <b><span></span></b>. 5576 You must omit this parameter in earlier versions, 5577 and you may omit it in any version. If you require this 5578 parameter, the manifest key 5579 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5580 can ensure that your extension won't be run in an earlier browser version. 5581 </dd> 5582 5583 <!-- OBJECT PROPERTIES --> 5584 <dd style="display: none; "> 5585 <dl> 5586 <div> 5587 <div> 5588 </div> 5589 </div> 5590 </dl> 5591 </dd> 5592 5593 <!-- FUNCTION PARAMETERS --> 5594 <dd style="display: none; "> 5595 <div></div> 5596 </dd> 5597 5598 </div> 5599 </div> 5600 </dl> 5601 </dd> 5602 5603 <!-- FUNCTION PARAMETERS --> 5604 <dd style="display: none; "> 5605 <div></div> 5606 </dd> 5607 5608 </div> 5609 </div> 5610 </dl> 5611 5612 </div> <!-- /decription --> 5613 5614 </div><div class="apiItem"> 5615 <a name="event-onMoved"></a> 5616 <h4>onMoved</h4> 5617 5618 <div class="summary"> 5619 <!-- Note: intentionally longer 80 columns --> 5620 <span class="subdued">chrome.tabs.</span><span>onMoved</span><span class="subdued">.addListener</span>(function(<span>integer tabId, object moveInfo</span>) <span class="subdued">{...}</span>); 5621 </div> 5622 5623 <div class="description"> 5624 <p class="todo" style="display: none; ">Undocumented.</p> 5625 <p>Fires when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response. This event is not fired when a tab is moved between windows. For that, see <a href="#event-onDetached">onDetached</a>.</p> 5626 5627 <!-- PARAMETERS --> 5628 <h4>Parameters</h4> 5629 <dl> 5630 <div> 5631 <div> 5632 <dt> 5633 <var>tabId</var> 5634 <em> 5635 5636 <!-- TYPE --> 5637 <div style="display:inline"> 5638 ( 5639 <span class="optional" style="display: none; ">optional</span> 5640 <span class="enum" style="display: none; ">enumerated</span> 5641 <span id="typeTemplate"> 5642 <span style="display: none; "> 5643 <a> Type</a> 5644 </span> 5645 <span> 5646 <span style="display: none; "> 5647 array of <span><span></span></span> 5648 </span> 5649 <span>integer</span> 5650 <span style="display: none; "></span> 5651 </span> 5652 </span> 5653 ) 5654 </div> 5655 5656 </em> 5657 </dt> 5658 <dd class="todo"> 5659 Undocumented. 5660 </dd> 5661 <dd style="display: none; "> 5662 Description of this parameter from the json schema. 5663 </dd> 5664 <dd style="display: none; "> 5665 This parameter was added in version 5666 <b><span></span></b>. 5667 You must omit this parameter in earlier versions, 5668 and you may omit it in any version. If you require this 5669 parameter, the manifest key 5670 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5671 can ensure that your extension won't be run in an earlier browser version. 5672 </dd> 5673 5674 <!-- OBJECT PROPERTIES --> 5675 <dd style="display: none; "> 5676 <dl> 5677 <div> 5678 <div> 5679 </div> 5680 </div> 5681 </dl> 5682 </dd> 5683 5684 <!-- FUNCTION PARAMETERS --> 5685 <dd style="display: none; "> 5686 <div></div> 5687 </dd> 5688 5689 </div> 5690 </div><div> 5691 <div> 5692 <dt> 5693 <var>moveInfo</var> 5694 <em> 5695 5696 <!-- TYPE --> 5697 <div style="display:inline"> 5698 ( 5699 <span class="optional" style="display: none; ">optional</span> 5700 <span class="enum" style="display: none; ">enumerated</span> 5701 <span id="typeTemplate"> 5702 <span style="display: none; "> 5703 <a> Type</a> 5704 </span> 5705 <span> 5706 <span style="display: none; "> 5707 array of <span><span></span></span> 5708 </span> 5709 <span>object</span> 5710 <span style="display: none; "></span> 5711 </span> 5712 </span> 5713 ) 5714 </div> 5715 5716 </em> 5717 </dt> 5718 <dd class="todo"> 5719 Undocumented. 5720 </dd> 5721 <dd style="display: none; "> 5722 Description of this parameter from the json schema. 5723 </dd> 5724 <dd style="display: none; "> 5725 This parameter was added in version 5726 <b><span></span></b>. 5727 You must omit this parameter in earlier versions, 5728 and you may omit it in any version. If you require this 5729 parameter, the manifest key 5730 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5731 can ensure that your extension won't be run in an earlier browser version. 5732 </dd> 5733 5734 <!-- OBJECT PROPERTIES --> 5735 <dd> 5736 <dl> 5737 <div> 5738 <div> 5739 <dt> 5740 <var>windowId</var> 5741 <em> 5742 5743 <!-- TYPE --> 5744 <div style="display:inline"> 5745 ( 5746 <span class="optional" style="display: none; ">optional</span> 5747 <span class="enum" style="display: none; ">enumerated</span> 5748 <span id="typeTemplate"> 5749 <span style="display: none; "> 5750 <a> Type</a> 5751 </span> 5752 <span> 5753 <span style="display: none; "> 5754 array of <span><span></span></span> 5755 </span> 5756 <span>integer</span> 5757 <span style="display: none; "></span> 5758 </span> 5759 </span> 5760 ) 5761 </div> 5762 5763 </em> 5764 </dt> 5765 <dd class="todo"> 5766 Undocumented. 5767 </dd> 5768 <dd style="display: none; "> 5769 Description of this parameter from the json schema. 5770 </dd> 5771 <dd style="display: none; "> 5772 This parameter was added in version 5773 <b><span></span></b>. 5774 You must omit this parameter in earlier versions, 5775 and you may omit it in any version. If you require this 5776 parameter, the manifest key 5777 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5778 can ensure that your extension won't be run in an earlier browser version. 5779 </dd> 5780 5781 <!-- OBJECT PROPERTIES --> 5782 <dd style="display: none; "> 5783 <dl> 5784 <div> 5785 <div> 5786 </div> 5787 </div> 5788 </dl> 5789 </dd> 5790 5791 <!-- FUNCTION PARAMETERS --> 5792 <dd style="display: none; "> 5793 <div></div> 5794 </dd> 5795 5796 </div> 5797 </div><div> 5798 <div> 5799 <dt> 5800 <var>fromIndex</var> 5801 <em> 5802 5803 <!-- TYPE --> 5804 <div style="display:inline"> 5805 ( 5806 <span class="optional" style="display: none; ">optional</span> 5807 <span class="enum" style="display: none; ">enumerated</span> 5808 <span id="typeTemplate"> 5809 <span style="display: none; "> 5810 <a> Type</a> 5811 </span> 5812 <span> 5813 <span style="display: none; "> 5814 array of <span><span></span></span> 5815 </span> 5816 <span>integer</span> 5817 <span style="display: none; "></span> 5818 </span> 5819 </span> 5820 ) 5821 </div> 5822 5823 </em> 5824 </dt> 5825 <dd class="todo"> 5826 Undocumented. 5827 </dd> 5828 <dd style="display: none; "> 5829 Description of this parameter from the json schema. 5830 </dd> 5831 <dd style="display: none; "> 5832 This parameter was added in version 5833 <b><span></span></b>. 5834 You must omit this parameter in earlier versions, 5835 and you may omit it in any version. If you require this 5836 parameter, the manifest key 5837 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5838 can ensure that your extension won't be run in an earlier browser version. 5839 </dd> 5840 5841 <!-- OBJECT PROPERTIES --> 5842 <dd style="display: none; "> 5843 <dl> 5844 <div> 5845 <div> 5846 </div> 5847 </div> 5848 </dl> 5849 </dd> 5850 5851 <!-- FUNCTION PARAMETERS --> 5852 <dd style="display: none; "> 5853 <div></div> 5854 </dd> 5855 5856 </div> 5857 </div><div> 5858 <div> 5859 <dt> 5860 <var>toIndex</var> 5861 <em> 5862 5863 <!-- TYPE --> 5864 <div style="display:inline"> 5865 ( 5866 <span class="optional" style="display: none; ">optional</span> 5867 <span class="enum" style="display: none; ">enumerated</span> 5868 <span id="typeTemplate"> 5869 <span style="display: none; "> 5870 <a> Type</a> 5871 </span> 5872 <span> 5873 <span style="display: none; "> 5874 array of <span><span></span></span> 5875 </span> 5876 <span>integer</span> 5877 <span style="display: none; "></span> 5878 </span> 5879 </span> 5880 ) 5881 </div> 5882 5883 </em> 5884 </dt> 5885 <dd class="todo"> 5886 Undocumented. 5887 </dd> 5888 <dd style="display: none; "> 5889 Description of this parameter from the json schema. 5890 </dd> 5891 <dd style="display: none; "> 5892 This parameter was added in version 5893 <b><span></span></b>. 5894 You must omit this parameter in earlier versions, 5895 and you may omit it in any version. If you require this 5896 parameter, the manifest key 5897 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5898 can ensure that your extension won't be run in an earlier browser version. 5899 </dd> 5900 5901 <!-- OBJECT PROPERTIES --> 5902 <dd style="display: none; "> 5903 <dl> 5904 <div> 5905 <div> 5906 </div> 5907 </div> 5908 </dl> 5909 </dd> 5910 5911 <!-- FUNCTION PARAMETERS --> 5912 <dd style="display: none; "> 5913 <div></div> 5914 </dd> 5915 5916 </div> 5917 </div> 5918 </dl> 5919 </dd> 5920 5921 <!-- FUNCTION PARAMETERS --> 5922 <dd style="display: none; "> 5923 <div></div> 5924 </dd> 5925 5926 </div> 5927 </div> 5928 </dl> 5929 5930 </div> <!-- /decription --> 5931 5932 </div><div class="apiItem"> 5933 <a name="event-onRemoved"></a> 5934 <h4>onRemoved</h4> 5935 5936 <div class="summary"> 5937 <!-- Note: intentionally longer 80 columns --> 5938 <span class="subdued">chrome.tabs.</span><span>onRemoved</span><span class="subdued">.addListener</span>(function(<span>integer tabId, object removeInfo</span>) <span class="subdued">{...}</span>); 5939 </div> 5940 5941 <div class="description"> 5942 <p class="todo" style="display: none; ">Undocumented.</p> 5943 <p>Fires when a tab is closed.</p> 5944 5945 <!-- PARAMETERS --> 5946 <h4>Parameters</h4> 5947 <dl> 5948 <div> 5949 <div> 5950 <dt> 5951 <var>tabId</var> 5952 <em> 5953 5954 <!-- TYPE --> 5955 <div style="display:inline"> 5956 ( 5957 <span class="optional" style="display: none; ">optional</span> 5958 <span class="enum" style="display: none; ">enumerated</span> 5959 <span id="typeTemplate"> 5960 <span style="display: none; "> 5961 <a> Type</a> 5962 </span> 5963 <span> 5964 <span style="display: none; "> 5965 array of <span><span></span></span> 5966 </span> 5967 <span>integer</span> 5968 <span style="display: none; "></span> 5969 </span> 5970 </span> 5971 ) 5972 </div> 5973 5974 </em> 5975 </dt> 5976 <dd class="todo"> 5977 Undocumented. 5978 </dd> 5979 <dd style="display: none; "> 5980 Description of this parameter from the json schema. 5981 </dd> 5982 <dd style="display: none; "> 5983 This parameter was added in version 5984 <b><span></span></b>. 5985 You must omit this parameter in earlier versions, 5986 and you may omit it in any version. If you require this 5987 parameter, the manifest key 5988 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 5989 can ensure that your extension won't be run in an earlier browser version. 5990 </dd> 5991 5992 <!-- OBJECT PROPERTIES --> 5993 <dd style="display: none; "> 5994 <dl> 5995 <div> 5996 <div> 5997 </div> 5998 </div> 5999 </dl> 6000 </dd> 6001 6002 <!-- FUNCTION PARAMETERS --> 6003 <dd style="display: none; "> 6004 <div></div> 6005 </dd> 6006 6007 </div> 6008 </div><div> 6009 <div> 6010 <dt> 6011 <var>removeInfo</var> 6012 <em> 6013 6014 <!-- TYPE --> 6015 <div style="display:inline"> 6016 ( 6017 <span class="optional" style="display: none; ">optional</span> 6018 <span class="enum" style="display: none; ">enumerated</span> 6019 <span id="typeTemplate"> 6020 <span style="display: none; "> 6021 <a> Type</a> 6022 </span> 6023 <span> 6024 <span style="display: none; "> 6025 array of <span><span></span></span> 6026 </span> 6027 <span>object</span> 6028 <span style="display: none; "></span> 6029 </span> 6030 </span> 6031 ) 6032 </div> 6033 6034 </em> 6035 </dt> 6036 <dd class="todo"> 6037 Undocumented. 6038 </dd> 6039 <dd style="display: none; "> 6040 Description of this parameter from the json schema. 6041 </dd> 6042 <dd style="display: none; "> 6043 This parameter was added in version 6044 <b><span></span></b>. 6045 You must omit this parameter in earlier versions, 6046 and you may omit it in any version. If you require this 6047 parameter, the manifest key 6048 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6049 can ensure that your extension won't be run in an earlier browser version. 6050 </dd> 6051 6052 <!-- OBJECT PROPERTIES --> 6053 <dd> 6054 <dl> 6055 <div> 6056 <div> 6057 <dt> 6058 <var>isWindowClosing</var> 6059 <em> 6060 6061 <!-- TYPE --> 6062 <div style="display:inline"> 6063 ( 6064 <span class="optional" style="display: none; ">optional</span> 6065 <span class="enum" style="display: none; ">enumerated</span> 6066 <span id="typeTemplate"> 6067 <span style="display: none; "> 6068 <a> Type</a> 6069 </span> 6070 <span> 6071 <span style="display: none; "> 6072 array of <span><span></span></span> 6073 </span> 6074 <span>boolean</span> 6075 <span style="display: none; "></span> 6076 </span> 6077 </span> 6078 ) 6079 </div> 6080 6081 </em> 6082 </dt> 6083 <dd class="todo" style="display: none; "> 6084 Undocumented. 6085 </dd> 6086 <dd>True when the tab is being closed because its window is being closed.</dd> 6087 <dd style="display: none; "> 6088 This parameter was added in version 6089 <b><span></span></b>. 6090 You must omit this parameter in earlier versions, 6091 and you may omit it in any version. If you require this 6092 parameter, the manifest key 6093 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6094 can ensure that your extension won't be run in an earlier browser version. 6095 </dd> 6096 6097 <!-- OBJECT PROPERTIES --> 6098 <dd style="display: none; "> 6099 <dl> 6100 <div> 6101 <div> 6102 </div> 6103 </div> 6104 </dl> 6105 </dd> 6106 6107 <!-- FUNCTION PARAMETERS --> 6108 <dd style="display: none; "> 6109 <div></div> 6110 </dd> 6111 6112 </div> 6113 </div> 6114 </dl> 6115 </dd> 6116 6117 <!-- FUNCTION PARAMETERS --> 6118 <dd style="display: none; "> 6119 <div></div> 6120 </dd> 6121 6122 </div> 6123 </div> 6124 </dl> 6125 6126 </div> <!-- /decription --> 6127 6128 </div><div class="apiItem"> 6129 <a name="event-onSelectionChanged"></a> 6130 <h4>onSelectionChanged</h4> 6131 6132 <div class="summary"> 6133 <!-- Note: intentionally longer 80 columns --> 6134 <span class="subdued">chrome.tabs.</span><span>onSelectionChanged</span><span class="subdued">.addListener</span>(function(<span>integer tabId, object selectInfo</span>) <span class="subdued">{...}</span>); 6135 </div> 6136 6137 <div class="description"> 6138 <p class="todo" style="display: none; ">Undocumented.</p> 6139 <p>Fires when the selected tab in a window changes.</p> 6140 6141 <!-- PARAMETERS --> 6142 <h4>Parameters</h4> 6143 <dl> 6144 <div> 6145 <div> 6146 <dt> 6147 <var>tabId</var> 6148 <em> 6149 6150 <!-- TYPE --> 6151 <div style="display:inline"> 6152 ( 6153 <span class="optional" style="display: none; ">optional</span> 6154 <span class="enum" style="display: none; ">enumerated</span> 6155 <span id="typeTemplate"> 6156 <span style="display: none; "> 6157 <a> Type</a> 6158 </span> 6159 <span> 6160 <span style="display: none; "> 6161 array of <span><span></span></span> 6162 </span> 6163 <span>integer</span> 6164 <span style="display: none; "></span> 6165 </span> 6166 </span> 6167 ) 6168 </div> 6169 6170 </em> 6171 </dt> 6172 <dd class="todo" style="display: none; "> 6173 Undocumented. 6174 </dd> 6175 <dd>The ID of the tab that has become selected.</dd> 6176 <dd style="display: none; "> 6177 This parameter was added in version 6178 <b><span></span></b>. 6179 You must omit this parameter in earlier versions, 6180 and you may omit it in any version. If you require this 6181 parameter, the manifest key 6182 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6183 can ensure that your extension won't be run in an earlier browser version. 6184 </dd> 6185 6186 <!-- OBJECT PROPERTIES --> 6187 <dd style="display: none; "> 6188 <dl> 6189 <div> 6190 <div> 6191 </div> 6192 </div> 6193 </dl> 6194 </dd> 6195 6196 <!-- FUNCTION PARAMETERS --> 6197 <dd style="display: none; "> 6198 <div></div> 6199 </dd> 6200 6201 </div> 6202 </div><div> 6203 <div> 6204 <dt> 6205 <var>selectInfo</var> 6206 <em> 6207 6208 <!-- TYPE --> 6209 <div style="display:inline"> 6210 ( 6211 <span class="optional" style="display: none; ">optional</span> 6212 <span class="enum" style="display: none; ">enumerated</span> 6213 <span id="typeTemplate"> 6214 <span style="display: none; "> 6215 <a> Type</a> 6216 </span> 6217 <span> 6218 <span style="display: none; "> 6219 array of <span><span></span></span> 6220 </span> 6221 <span>object</span> 6222 <span style="display: none; "></span> 6223 </span> 6224 </span> 6225 ) 6226 </div> 6227 6228 </em> 6229 </dt> 6230 <dd class="todo"> 6231 Undocumented. 6232 </dd> 6233 <dd style="display: none; "> 6234 Description of this parameter from the json schema. 6235 </dd> 6236 <dd style="display: none; "> 6237 This parameter was added in version 6238 <b><span></span></b>. 6239 You must omit this parameter in earlier versions, 6240 and you may omit it in any version. If you require this 6241 parameter, the manifest key 6242 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6243 can ensure that your extension won't be run in an earlier browser version. 6244 </dd> 6245 6246 <!-- OBJECT PROPERTIES --> 6247 <dd> 6248 <dl> 6249 <div> 6250 <div> 6251 <dt> 6252 <var>windowId</var> 6253 <em> 6254 6255 <!-- TYPE --> 6256 <div style="display:inline"> 6257 ( 6258 <span class="optional" style="display: none; ">optional</span> 6259 <span class="enum" style="display: none; ">enumerated</span> 6260 <span id="typeTemplate"> 6261 <span style="display: none; "> 6262 <a> Type</a> 6263 </span> 6264 <span> 6265 <span style="display: none; "> 6266 array of <span><span></span></span> 6267 </span> 6268 <span>integer</span> 6269 <span style="display: none; "></span> 6270 </span> 6271 </span> 6272 ) 6273 </div> 6274 6275 </em> 6276 </dt> 6277 <dd class="todo" style="display: none; "> 6278 Undocumented. 6279 </dd> 6280 <dd>The ID of the window the selected tab changed inside of.</dd> 6281 <dd style="display: none; "> 6282 This parameter was added in version 6283 <b><span></span></b>. 6284 You must omit this parameter in earlier versions, 6285 and you may omit it in any version. If you require this 6286 parameter, the manifest key 6287 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6288 can ensure that your extension won't be run in an earlier browser version. 6289 </dd> 6290 6291 <!-- OBJECT PROPERTIES --> 6292 <dd style="display: none; "> 6293 <dl> 6294 <div> 6295 <div> 6296 </div> 6297 </div> 6298 </dl> 6299 </dd> 6300 6301 <!-- FUNCTION PARAMETERS --> 6302 <dd style="display: none; "> 6303 <div></div> 6304 </dd> 6305 6306 </div> 6307 </div> 6308 </dl> 6309 </dd> 6310 6311 <!-- FUNCTION PARAMETERS --> 6312 <dd style="display: none; "> 6313 <div></div> 6314 </dd> 6315 6316 </div> 6317 </div> 6318 </dl> 6319 6320 </div> <!-- /decription --> 6321 6322 </div><div class="apiItem"> 6323 <a name="event-onUpdated"></a> 6324 <h4>onUpdated</h4> 6325 6326 <div class="summary"> 6327 <!-- Note: intentionally longer 80 columns --> 6328 <span class="subdued">chrome.tabs.</span><span>onUpdated</span><span class="subdued">.addListener</span>(function(<span>integer tabId, object changeInfo, Tab tab</span>) <span class="subdued">{...}</span>); 6329 </div> 6330 6331 <div class="description"> 6332 <p class="todo" style="display: none; ">Undocumented.</p> 6333 <p>Fires when a tab is updated.</p> 6334 6335 <!-- PARAMETERS --> 6336 <h4>Parameters</h4> 6337 <dl> 6338 <div> 6339 <div> 6340 <dt> 6341 <var>tabId</var> 6342 <em> 6343 6344 <!-- TYPE --> 6345 <div style="display:inline"> 6346 ( 6347 <span class="optional" style="display: none; ">optional</span> 6348 <span class="enum" style="display: none; ">enumerated</span> 6349 <span id="typeTemplate"> 6350 <span style="display: none; "> 6351 <a> Type</a> 6352 </span> 6353 <span> 6354 <span style="display: none; "> 6355 array of <span><span></span></span> 6356 </span> 6357 <span>integer</span> 6358 <span style="display: none; "></span> 6359 </span> 6360 </span> 6361 ) 6362 </div> 6363 6364 </em> 6365 </dt> 6366 <dd class="todo"> 6367 Undocumented. 6368 </dd> 6369 <dd style="display: none; "> 6370 Description of this parameter from the json schema. 6371 </dd> 6372 <dd style="display: none; "> 6373 This parameter was added in version 6374 <b><span></span></b>. 6375 You must omit this parameter in earlier versions, 6376 and you may omit it in any version. If you require this 6377 parameter, the manifest key 6378 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6379 can ensure that your extension won't be run in an earlier browser version. 6380 </dd> 6381 6382 <!-- OBJECT PROPERTIES --> 6383 <dd style="display: none; "> 6384 <dl> 6385 <div> 6386 <div> 6387 </div> 6388 </div> 6389 </dl> 6390 </dd> 6391 6392 <!-- FUNCTION PARAMETERS --> 6393 <dd style="display: none; "> 6394 <div></div> 6395 </dd> 6396 6397 </div> 6398 </div><div> 6399 <div> 6400 <dt> 6401 <var>changeInfo</var> 6402 <em> 6403 6404 <!-- TYPE --> 6405 <div style="display:inline"> 6406 ( 6407 <span class="optional" style="display: none; ">optional</span> 6408 <span class="enum" style="display: none; ">enumerated</span> 6409 <span id="typeTemplate"> 6410 <span style="display: none; "> 6411 <a> Type</a> 6412 </span> 6413 <span> 6414 <span style="display: none; "> 6415 array of <span><span></span></span> 6416 </span> 6417 <span>object</span> 6418 <span style="display: none; "></span> 6419 </span> 6420 </span> 6421 ) 6422 </div> 6423 6424 </em> 6425 </dt> 6426 <dd class="todo" style="display: none; "> 6427 Undocumented. 6428 </dd> 6429 <dd>Lists the changes to the state of the tab that was updated.</dd> 6430 <dd style="display: none; "> 6431 This parameter was added in version 6432 <b><span></span></b>. 6433 You must omit this parameter in earlier versions, 6434 and you may omit it in any version. If you require this 6435 parameter, the manifest key 6436 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6437 can ensure that your extension won't be run in an earlier browser version. 6438 </dd> 6439 6440 <!-- OBJECT PROPERTIES --> 6441 <dd> 6442 <dl> 6443 <div> 6444 <div> 6445 <dt> 6446 <var>status</var> 6447 <em> 6448 6449 <!-- TYPE --> 6450 <div style="display:inline"> 6451 ( 6452 <span class="optional">optional</span> 6453 <span class="enum" style="display: none; ">enumerated</span> 6454 <span id="typeTemplate"> 6455 <span style="display: none; "> 6456 <a> Type</a> 6457 </span> 6458 <span> 6459 <span style="display: none; "> 6460 array of <span><span></span></span> 6461 </span> 6462 <span>string</span> 6463 <span style="display: none; "></span> 6464 </span> 6465 </span> 6466 ) 6467 </div> 6468 6469 </em> 6470 </dt> 6471 <dd class="todo" style="display: none; "> 6472 Undocumented. 6473 </dd> 6474 <dd>The status of the tab. Can be either <em>loading</em> or <em>complete</em>.</dd> 6475 <dd style="display: none; "> 6476 This parameter was added in version 6477 <b><span></span></b>. 6478 You must omit this parameter in earlier versions, 6479 and you may omit it in any version. If you require this 6480 parameter, the manifest key 6481 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6482 can ensure that your extension won't be run in an earlier browser version. 6483 </dd> 6484 6485 <!-- OBJECT PROPERTIES --> 6486 <dd style="display: none; "> 6487 <dl> 6488 <div> 6489 <div> 6490 </div> 6491 </div> 6492 </dl> 6493 </dd> 6494 6495 <!-- FUNCTION PARAMETERS --> 6496 <dd style="display: none; "> 6497 <div></div> 6498 </dd> 6499 6500 </div> 6501 </div><div> 6502 <div> 6503 <dt> 6504 <var>url</var> 6505 <em> 6506 6507 <!-- TYPE --> 6508 <div style="display:inline"> 6509 ( 6510 <span class="optional">optional</span> 6511 <span class="enum" style="display: none; ">enumerated</span> 6512 <span id="typeTemplate"> 6513 <span style="display: none; "> 6514 <a> Type</a> 6515 </span> 6516 <span> 6517 <span style="display: none; "> 6518 array of <span><span></span></span> 6519 </span> 6520 <span>string</span> 6521 <span style="display: none; "></span> 6522 </span> 6523 </span> 6524 ) 6525 </div> 6526 6527 </em> 6528 </dt> 6529 <dd class="todo" style="display: none; "> 6530 Undocumented. 6531 </dd> 6532 <dd>The tab's URL if it has changed.</dd> 6533 <dd style="display: none; "> 6534 This parameter was added in version 6535 <b><span></span></b>. 6536 You must omit this parameter in earlier versions, 6537 and you may omit it in any version. If you require this 6538 parameter, the manifest key 6539 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6540 can ensure that your extension won't be run in an earlier browser version. 6541 </dd> 6542 6543 <!-- OBJECT PROPERTIES --> 6544 <dd style="display: none; "> 6545 <dl> 6546 <div> 6547 <div> 6548 </div> 6549 </div> 6550 </dl> 6551 </dd> 6552 6553 <!-- FUNCTION PARAMETERS --> 6554 <dd style="display: none; "> 6555 <div></div> 6556 </dd> 6557 6558 </div> 6559 </div><div> 6560 <div> 6561 <dt> 6562 <var>pinned</var> 6563 <em> 6564 6565 <!-- TYPE --> 6566 <div style="display:inline"> 6567 ( 6568 <span class="optional">optional</span> 6569 <span class="enum" style="display: none; ">enumerated</span> 6570 <span id="typeTemplate"> 6571 <span style="display: none; "> 6572 <a> Type</a> 6573 </span> 6574 <span> 6575 <span style="display: none; "> 6576 array of <span><span></span></span> 6577 </span> 6578 <span>boolean</span> 6579 <span style="display: none; "></span> 6580 </span> 6581 </span> 6582 ) 6583 </div> 6584 6585 </em> 6586 </dt> 6587 <dd class="todo" style="display: none; "> 6588 Undocumented. 6589 </dd> 6590 <dd>The tab's new pinned state.</dd> 6591 <dd style="display: none; "> 6592 This parameter was added in version 6593 <b><span></span></b>. 6594 You must omit this parameter in earlier versions, 6595 and you may omit it in any version. If you require this 6596 parameter, the manifest key 6597 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6598 can ensure that your extension won't be run in an earlier browser version. 6599 </dd> 6600 6601 <!-- OBJECT PROPERTIES --> 6602 <dd style="display: none; "> 6603 <dl> 6604 <div> 6605 <div> 6606 </div> 6607 </div> 6608 </dl> 6609 </dd> 6610 6611 <!-- FUNCTION PARAMETERS --> 6612 <dd style="display: none; "> 6613 <div></div> 6614 </dd> 6615 6616 </div> 6617 </div> 6618 </dl> 6619 </dd> 6620 6621 <!-- FUNCTION PARAMETERS --> 6622 <dd style="display: none; "> 6623 <div></div> 6624 </dd> 6625 6626 </div> 6627 </div><div> 6628 <div> 6629 <dt> 6630 <var>tab</var> 6631 <em> 6632 6633 <!-- TYPE --> 6634 <div style="display:inline"> 6635 ( 6636 <span class="optional" style="display: none; ">optional</span> 6637 <span class="enum" style="display: none; ">enumerated</span> 6638 <span id="typeTemplate"> 6639 <span> 6640 <a href="tabs.html#type-Tab">Tab</a> 6641 </span> 6642 <span style="display: none; "> 6643 <span> 6644 array of <span><span></span></span> 6645 </span> 6646 <span>paramType</span> 6647 <span></span> 6648 </span> 6649 </span> 6650 ) 6651 </div> 6652 6653 </em> 6654 </dt> 6655 <dd class="todo" style="display: none; "> 6656 Undocumented. 6657 </dd> 6658 <dd>Gives the state of the tab that was updated.</dd> 6659 <dd style="display: none; "> 6660 This parameter was added in version 6661 <b><span></span></b>. 6662 You must omit this parameter in earlier versions, 6663 and you may omit it in any version. If you require this 6664 parameter, the manifest key 6665 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6666 can ensure that your extension won't be run in an earlier browser version. 6667 </dd> 6668 6669 <!-- OBJECT PROPERTIES --> 6670 <dd style="display: none; "> 6671 <dl> 6672 <div> 6673 <div> 6674 </div> 6675 </div> 6676 </dl> 6677 </dd> 6678 6679 <!-- FUNCTION PARAMETERS --> 6680 <dd style="display: none; "> 6681 <div></div> 6682 </dd> 6683 6684 </div> 6685 </div> 6686 </dl> 6687 6688 </div> <!-- /decription --> 6689 6690 </div> <!-- /apiItem --> 6691 6692 </div> <!-- /apiGroup --> 6693 6694 <!-- TYPES --> 6695 <div class="apiGroup"> 6696 <a name="types"></a> 6697 <h3 id="types">Types</h3> 6698 6699 <!-- iterates over all types --> 6700 <div class="apiItem"> 6701 <a name="type-Tab"></a> 6702 <h4>Tab</h4> 6703 6704 <div> 6705 <dt> 6706 <var style="display: none; ">paramName</var> 6707 <em> 6708 6709 <!-- TYPE --> 6710 <div style="display:inline"> 6711 ( 6712 <span class="optional" style="display: none; ">optional</span> 6713 <span class="enum" style="display: none; ">enumerated</span> 6714 <span id="typeTemplate"> 6715 <span style="display: none; "> 6716 <a> Type</a> 6717 </span> 6718 <span> 6719 <span style="display: none; "> 6720 array of <span><span></span></span> 6721 </span> 6722 <span>object</span> 6723 <span style="display: none; "></span> 6724 </span> 6725 </span> 6726 ) 6727 </div> 6728 6729 </em> 6730 </dt> 6731 <dd class="todo"> 6732 Undocumented. 6733 </dd> 6734 <dd style="display: none; "> 6735 Description of this parameter from the json schema. 6736 </dd> 6737 <dd style="display: none; "> 6738 This parameter was added in version 6739 <b><span></span></b>. 6740 You must omit this parameter in earlier versions, 6741 and you may omit it in any version. If you require this 6742 parameter, the manifest key 6743 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6744 can ensure that your extension won't be run in an earlier browser version. 6745 </dd> 6746 6747 <!-- OBJECT PROPERTIES --> 6748 <dd> 6749 <dl> 6750 <div> 6751 <div> 6752 <dt> 6753 <var>id</var> 6754 <em> 6755 6756 <!-- TYPE --> 6757 <div style="display:inline"> 6758 ( 6759 <span class="optional" style="display: none; ">optional</span> 6760 <span class="enum" style="display: none; ">enumerated</span> 6761 <span id="typeTemplate"> 6762 <span style="display: none; "> 6763 <a> Type</a> 6764 </span> 6765 <span> 6766 <span style="display: none; "> 6767 array of <span><span></span></span> 6768 </span> 6769 <span>integer</span> 6770 <span style="display: none; "></span> 6771 </span> 6772 </span> 6773 ) 6774 </div> 6775 6776 </em> 6777 </dt> 6778 <dd class="todo" style="display: none; "> 6779 Undocumented. 6780 </dd> 6781 <dd>The ID of the tab. Tab IDs are unique within a browser session.</dd> 6782 <dd style="display: none; "> 6783 This parameter was added in version 6784 <b><span></span></b>. 6785 You must omit this parameter in earlier versions, 6786 and you may omit it in any version. If you require this 6787 parameter, the manifest key 6788 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6789 can ensure that your extension won't be run in an earlier browser version. 6790 </dd> 6791 6792 <!-- OBJECT PROPERTIES --> 6793 <dd style="display: none; "> 6794 <dl> 6795 <div> 6796 <div> 6797 </div> 6798 </div> 6799 </dl> 6800 </dd> 6801 6802 <!-- FUNCTION PARAMETERS --> 6803 <dd style="display: none; "> 6804 <div></div> 6805 </dd> 6806 6807 </div> 6808 </div><div> 6809 <div> 6810 <dt> 6811 <var>index</var> 6812 <em> 6813 6814 <!-- TYPE --> 6815 <div style="display:inline"> 6816 ( 6817 <span class="optional" style="display: none; ">optional</span> 6818 <span class="enum" style="display: none; ">enumerated</span> 6819 <span id="typeTemplate"> 6820 <span style="display: none; "> 6821 <a> Type</a> 6822 </span> 6823 <span> 6824 <span style="display: none; "> 6825 array of <span><span></span></span> 6826 </span> 6827 <span>integer</span> 6828 <span style="display: none; "></span> 6829 </span> 6830 </span> 6831 ) 6832 </div> 6833 6834 </em> 6835 </dt> 6836 <dd class="todo" style="display: none; "> 6837 Undocumented. 6838 </dd> 6839 <dd>The zero-based index of the tab within its window.</dd> 6840 <dd style="display: none; "> 6841 This parameter was added in version 6842 <b><span></span></b>. 6843 You must omit this parameter in earlier versions, 6844 and you may omit it in any version. If you require this 6845 parameter, the manifest key 6846 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6847 can ensure that your extension won't be run in an earlier browser version. 6848 </dd> 6849 6850 <!-- OBJECT PROPERTIES --> 6851 <dd style="display: none; "> 6852 <dl> 6853 <div> 6854 <div> 6855 </div> 6856 </div> 6857 </dl> 6858 </dd> 6859 6860 <!-- FUNCTION PARAMETERS --> 6861 <dd style="display: none; "> 6862 <div></div> 6863 </dd> 6864 6865 </div> 6866 </div><div> 6867 <div> 6868 <dt> 6869 <var>windowId</var> 6870 <em> 6871 6872 <!-- TYPE --> 6873 <div style="display:inline"> 6874 ( 6875 <span class="optional" style="display: none; ">optional</span> 6876 <span class="enum" style="display: none; ">enumerated</span> 6877 <span id="typeTemplate"> 6878 <span style="display: none; "> 6879 <a> Type</a> 6880 </span> 6881 <span> 6882 <span style="display: none; "> 6883 array of <span><span></span></span> 6884 </span> 6885 <span>integer</span> 6886 <span style="display: none; "></span> 6887 </span> 6888 </span> 6889 ) 6890 </div> 6891 6892 </em> 6893 </dt> 6894 <dd class="todo" style="display: none; "> 6895 Undocumented. 6896 </dd> 6897 <dd>The ID of the window the tab is contained within.</dd> 6898 <dd style="display: none; "> 6899 This parameter was added in version 6900 <b><span></span></b>. 6901 You must omit this parameter in earlier versions, 6902 and you may omit it in any version. If you require this 6903 parameter, the manifest key 6904 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6905 can ensure that your extension won't be run in an earlier browser version. 6906 </dd> 6907 6908 <!-- OBJECT PROPERTIES --> 6909 <dd style="display: none; "> 6910 <dl> 6911 <div> 6912 <div> 6913 </div> 6914 </div> 6915 </dl> 6916 </dd> 6917 6918 <!-- FUNCTION PARAMETERS --> 6919 <dd style="display: none; "> 6920 <div></div> 6921 </dd> 6922 6923 </div> 6924 </div><div> 6925 <div> 6926 <dt> 6927 <var>selected</var> 6928 <em> 6929 6930 <!-- TYPE --> 6931 <div style="display:inline"> 6932 ( 6933 <span class="optional" style="display: none; ">optional</span> 6934 <span class="enum" style="display: none; ">enumerated</span> 6935 <span id="typeTemplate"> 6936 <span style="display: none; "> 6937 <a> Type</a> 6938 </span> 6939 <span> 6940 <span style="display: none; "> 6941 array of <span><span></span></span> 6942 </span> 6943 <span>boolean</span> 6944 <span style="display: none; "></span> 6945 </span> 6946 </span> 6947 ) 6948 </div> 6949 6950 </em> 6951 </dt> 6952 <dd class="todo" style="display: none; "> 6953 Undocumented. 6954 </dd> 6955 <dd>Whether the tab is selected.</dd> 6956 <dd style="display: none; "> 6957 This parameter was added in version 6958 <b><span></span></b>. 6959 You must omit this parameter in earlier versions, 6960 and you may omit it in any version. If you require this 6961 parameter, the manifest key 6962 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 6963 can ensure that your extension won't be run in an earlier browser version. 6964 </dd> 6965 6966 <!-- OBJECT PROPERTIES --> 6967 <dd style="display: none; "> 6968 <dl> 6969 <div> 6970 <div> 6971 </div> 6972 </div> 6973 </dl> 6974 </dd> 6975 6976 <!-- FUNCTION PARAMETERS --> 6977 <dd style="display: none; "> 6978 <div></div> 6979 </dd> 6980 6981 </div> 6982 </div><div> 6983 <div> 6984 <dt> 6985 <var>pinned</var> 6986 <em> 6987 6988 <!-- TYPE --> 6989 <div style="display:inline"> 6990 ( 6991 <span class="optional" style="display: none; ">optional</span> 6992 <span class="enum" style="display: none; ">enumerated</span> 6993 <span id="typeTemplate"> 6994 <span style="display: none; "> 6995 <a> Type</a> 6996 </span> 6997 <span> 6998 <span style="display: none; "> 6999 array of <span><span></span></span> 7000 </span> 7001 <span>boolean</span> 7002 <span style="display: none; "></span> 7003 </span> 7004 </span> 7005 ) 7006 </div> 7007 7008 </em> 7009 </dt> 7010 <dd class="todo" style="display: none; "> 7011 Undocumented. 7012 </dd> 7013 <dd>Whether the tab is pinned.</dd> 7014 <dd style="display: none; "> 7015 This parameter was added in version 7016 <b><span></span></b>. 7017 You must omit this parameter in earlier versions, 7018 and you may omit it in any version. If you require this 7019 parameter, the manifest key 7020 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 7021 can ensure that your extension won't be run in an earlier browser version. 7022 </dd> 7023 7024 <!-- OBJECT PROPERTIES --> 7025 <dd style="display: none; "> 7026 <dl> 7027 <div> 7028 <div> 7029 </div> 7030 </div> 7031 </dl> 7032 </dd> 7033 7034 <!-- FUNCTION PARAMETERS --> 7035 <dd style="display: none; "> 7036 <div></div> 7037 </dd> 7038 7039 </div> 7040 </div><div> 7041 <div> 7042 <dt> 7043 <var>url</var> 7044 <em> 7045 7046 <!-- TYPE --> 7047 <div style="display:inline"> 7048 ( 7049 <span class="optional" style="display: none; ">optional</span> 7050 <span class="enum" style="display: none; ">enumerated</span> 7051 <span id="typeTemplate"> 7052 <span style="display: none; "> 7053 <a> Type</a> 7054 </span> 7055 <span> 7056 <span style="display: none; "> 7057 array of <span><span></span></span> 7058 </span> 7059 <span>string</span> 7060 <span style="display: none; "></span> 7061 </span> 7062 </span> 7063 ) 7064 </div> 7065 7066 </em> 7067 </dt> 7068 <dd class="todo" style="display: none; "> 7069 Undocumented. 7070 </dd> 7071 <dd>The URL the tab is displaying.</dd> 7072 <dd style="display: none; "> 7073 This parameter was added in version 7074 <b><span></span></b>. 7075 You must omit this parameter in earlier versions, 7076 and you may omit it in any version. If you require this 7077 parameter, the manifest key 7078 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 7079 can ensure that your extension won't be run in an earlier browser version. 7080 </dd> 7081 7082 <!-- OBJECT PROPERTIES --> 7083 <dd style="display: none; "> 7084 <dl> 7085 <div> 7086 <div> 7087 </div> 7088 </div> 7089 </dl> 7090 </dd> 7091 7092 <!-- FUNCTION PARAMETERS --> 7093 <dd style="display: none; "> 7094 <div></div> 7095 </dd> 7096 7097 </div> 7098 </div><div> 7099 <div> 7100 <dt> 7101 <var>title</var> 7102 <em> 7103 7104 <!-- TYPE --> 7105 <div style="display:inline"> 7106 ( 7107 <span class="optional">optional</span> 7108 <span class="enum" style="display: none; ">enumerated</span> 7109 <span id="typeTemplate"> 7110 <span style="display: none; "> 7111 <a> Type</a> 7112 </span> 7113 <span> 7114 <span style="display: none; "> 7115 array of <span><span></span></span> 7116 </span> 7117 <span>string</span> 7118 <span style="display: none; "></span> 7119 </span> 7120 </span> 7121 ) 7122 </div> 7123 7124 </em> 7125 </dt> 7126 <dd class="todo" style="display: none; "> 7127 Undocumented. 7128 </dd> 7129 <dd>The title of the tab. This may not be available if the tab is loading.</dd> 7130 <dd style="display: none; "> 7131 This parameter was added in version 7132 <b><span></span></b>. 7133 You must omit this parameter in earlier versions, 7134 and you may omit it in any version. If you require this 7135 parameter, the manifest key 7136 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 7137 can ensure that your extension won't be run in an earlier browser version. 7138 </dd> 7139 7140 <!-- OBJECT PROPERTIES --> 7141 <dd style="display: none; "> 7142 <dl> 7143 <div> 7144 <div> 7145 </div> 7146 </div> 7147 </dl> 7148 </dd> 7149 7150 <!-- FUNCTION PARAMETERS --> 7151 <dd style="display: none; "> 7152 <div></div> 7153 </dd> 7154 7155 </div> 7156 </div><div> 7157 <div> 7158 <dt> 7159 <var>favIconUrl</var> 7160 <em> 7161 7162 <!-- TYPE --> 7163 <div style="display:inline"> 7164 ( 7165 <span class="optional">optional</span> 7166 <span class="enum" style="display: none; ">enumerated</span> 7167 <span id="typeTemplate"> 7168 <span style="display: none; "> 7169 <a> Type</a> 7170 </span> 7171 <span> 7172 <span style="display: none; "> 7173 array of <span><span></span></span> 7174 </span> 7175 <span>string</span> 7176 <span style="display: none; "></span> 7177 </span> 7178 </span> 7179 ) 7180 </div> 7181 7182 </em> 7183 </dt> 7184 <dd class="todo" style="display: none; "> 7185 Undocumented. 7186 </dd> 7187 <dd>The URL of the tab's favicon. This may not be available if the tab is loading.</dd> 7188 <dd style="display: none; "> 7189 This parameter was added in version 7190 <b><span></span></b>. 7191 You must omit this parameter in earlier versions, 7192 and you may omit it in any version. If you require this 7193 parameter, the manifest key 7194 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 7195 can ensure that your extension won't be run in an earlier browser version. 7196 </dd> 7197 7198 <!-- OBJECT PROPERTIES --> 7199 <dd style="display: none; "> 7200 <dl> 7201 <div> 7202 <div> 7203 </div> 7204 </div> 7205 </dl> 7206 </dd> 7207 7208 <!-- FUNCTION PARAMETERS --> 7209 <dd style="display: none; "> 7210 <div></div> 7211 </dd> 7212 7213 </div> 7214 </div><div> 7215 <div> 7216 <dt> 7217 <var>status</var> 7218 <em> 7219 7220 <!-- TYPE --> 7221 <div style="display:inline"> 7222 ( 7223 <span class="optional">optional</span> 7224 <span class="enum" style="display: none; ">enumerated</span> 7225 <span id="typeTemplate"> 7226 <span style="display: none; "> 7227 <a> Type</a> 7228 </span> 7229 <span> 7230 <span style="display: none; "> 7231 array of <span><span></span></span> 7232 </span> 7233 <span>string</span> 7234 <span style="display: none; "></span> 7235 </span> 7236 </span> 7237 ) 7238 </div> 7239 7240 </em> 7241 </dt> 7242 <dd class="todo" style="display: none; "> 7243 Undocumented. 7244 </dd> 7245 <dd>Either <em>loading</em> or <em>complete</em>.</dd> 7246 <dd style="display: none; "> 7247 This parameter was added in version 7248 <b><span></span></b>. 7249 You must omit this parameter in earlier versions, 7250 and you may omit it in any version. If you require this 7251 parameter, the manifest key 7252 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 7253 can ensure that your extension won't be run in an earlier browser version. 7254 </dd> 7255 7256 <!-- OBJECT PROPERTIES --> 7257 <dd style="display: none; "> 7258 <dl> 7259 <div> 7260 <div> 7261 </div> 7262 </div> 7263 </dl> 7264 </dd> 7265 7266 <!-- FUNCTION PARAMETERS --> 7267 <dd style="display: none; "> 7268 <div></div> 7269 </dd> 7270 7271 </div> 7272 </div><div> 7273 <div> 7274 <dt> 7275 <var>incognito</var> 7276 <em> 7277 7278 <!-- TYPE --> 7279 <div style="display:inline"> 7280 ( 7281 <span class="optional" style="display: none; ">optional</span> 7282 <span class="enum" style="display: none; ">enumerated</span> 7283 <span id="typeTemplate"> 7284 <span style="display: none; "> 7285 <a> Type</a> 7286 </span> 7287 <span> 7288 <span style="display: none; "> 7289 array of <span><span></span></span> 7290 </span> 7291 <span>boolean</span> 7292 <span style="display: none; "></span> 7293 </span> 7294 </span> 7295 ) 7296 </div> 7297 7298 </em> 7299 </dt> 7300 <dd class="todo" style="display: none; "> 7301 Undocumented. 7302 </dd> 7303 <dd>Whether the tab is in an incognito window.</dd> 7304 <dd style="display: none; "> 7305 This parameter was added in version 7306 <b><span></span></b>. 7307 You must omit this parameter in earlier versions, 7308 and you may omit it in any version. If you require this 7309 parameter, the manifest key 7310 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 7311 can ensure that your extension won't be run in an earlier browser version. 7312 </dd> 7313 7314 <!-- OBJECT PROPERTIES --> 7315 <dd style="display: none; "> 7316 <dl> 7317 <div> 7318 <div> 7319 </div> 7320 </div> 7321 </dl> 7322 </dd> 7323 7324 <!-- FUNCTION PARAMETERS --> 7325 <dd style="display: none; "> 7326 <div></div> 7327 </dd> 7328 7329 </div> 7330 </div> 7331 </dl> 7332 </dd> 7333 7334 <!-- FUNCTION PARAMETERS --> 7335 <dd style="display: none; "> 7336 <div></div> 7337 </dd> 7338 7339 </div> 7340 7341 </div> <!-- /apiItem --> 7342 7343 </div> <!-- /apiGroup --> 7344 7345 </div> <!-- /apiPage --> 7346 </div> <!-- /gc-pagecontent --> 7347 </div> <!-- /g-section --> 7348 </div> <!-- /codesiteContent --> 7349 <div id="gc-footer" --=""> 7350 <div class="text"> 7351 <p> 7352 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 7353 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 7354 Attribution 3.0 License</a>, and code samples are licensed under the 7355 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 7356 </p> 7357 <p> 7358 ©2010 Google 7359 </p> 7360 7361<!-- begin analytics --> 7362<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 7363<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 7364 7365<script type="text/javascript"> 7366 // chrome doc tracking 7367 try { 7368 var engdocs = _gat._getTracker("YT-10763712-2"); 7369 engdocs._trackPageview(); 7370 } catch(err) {} 7371 7372 // code.google.com site-wide tracking 7373 try { 7374 _uacct="UA-18071-1"; 7375 _uanchor=1; 7376 _uff=0; 7377 urchinTracker(); 7378 } 7379 catch(e) {/* urchinTracker not available. */} 7380</script> 7381<!-- end analytics --> 7382 </div> 7383 </div> <!-- /gc-footer --> 7384 </div> <!-- /gc-container --> 7385</body></html> 7386
