chrome/common/extensions/docs/tabs.html - Issue 10642015: Basic setup for generating app docs

Side by Side Diff: chrome/common/extensions/docs/tabs.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

OLD	NEW
	(Empty)
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/jstempla te_compiled.js">

15 </script>

16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">

17 </script>

18 <script type="text/javascript" src="js/api_page_generator.js"></script>

19 <script type="text/javascript" src="js/bootstrap.js"></script>

20 <script type="text/javascript" src="js/sidebar.js"></script>

21 <meta name="description" content="Documentation for the chrome.tabs module, wh ich is part of the Google Chrome extension APIs."><title>Tabs - Google Chrome E xtensions - Google Code</title></head>

22 <body> <div id="devModeWarning" class="displayModeWarning">

23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.

24 </div>

25 <div id="branchWarning" class="displayModeWarning">

26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

27 It may not work with the stable release of Chrome.</span>

28 <select id="branchChooser">

29 <option>Choose a different version...

30 </option><option value="">Stable

31 </option><option value="beta">Beta

32 </option><option value="dev">Dev

33 </option><option value="trunk">Trunk

34 </option></select>

35 </div>

36 <div id="unofficialWarning" class="displayModeWarning">

37 <span>WARNING: This is unofficial documentation. It may not work with the

38 current release of Chrome.</span>

39 <button id="goToOfficialDocs">Go to the official docs</button>

40 </div>

41 <div id="gc-container" class="labs">

42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->

43 <!-- In particular, sub-templates that recurse, must be used by allowing

44 jstemplate to make a copy of the template in this section which

45 are not operated on by way of the jsskip="true" -->

46 <!-- /SUBTEMPLATES -->

47 <a id="top"></a>

48 <div id="skipto">

49 <a href="#gc-pagecontent">Skip to page content</a>

50 <a href="#gc-toc">Skip to main navigation</a>

51 </div>

52 <!-- API HEADER -->

53 <table id="header" width="100%" cellspacing="0" border="0">

54 <tbody><tr>

55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>

56 <td valign="middle" width="100%" style="padding-left:0.6em;">

57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">

58 <div id="gsc-search-box">

59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">

60 <input type="hidden" name="ie" value="UTF-8">

61 <input type="text" name="q" value="" size="55">

62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">

63 <br>

64 <span class="greytext">e.g. "page action" or "tabs"</span>

65 </div>

66 </form>

67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>

68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&t13n_langs=en"></script>

70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&lang=en"></script>

71 </td>

72 </tr>

73 </tbody></table>

74 <div id="codesiteContent" class="">

75 <a id="gc-topnav-anchor"></a>

76 <div id="gc-topnav">

77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>

78 <ul id="home" class="gc-topnav-tabs">

79 <li id="home_link">

80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>

81 </li>

82 <li id="docs_link">

83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>

84 </li>

85 <li id="faq_link">

86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>

87 </li>

88 <li id="samples_link">

89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>

90 </li>

91 <li id="group_link">

92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>

93 </li>

94 <li id="so_link">

95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

96 </li>

97 </ul>

98 </div> <!-- end gc-topnav -->

99 <div class="g-section g-tpl-170">

100 <!-- SIDENAV -->

101 <div class="g-unit g-first" id="gc-toc">

102 <ul>

103 <li><a href="getstarted.html">Getting Started</a></li>

104 <li><a href="overview.html">Overview</a></li>

105 <li><a href="whats_new.html">What's New?</a></li>

106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>

107 <ul>

108 <li>Browser UI

109 <ul>

110 <li><a href="browserAction.html">Browser Actions</a></li>

111 <li><a href="contextMenus.html">Context Menus</a></li>

112 <li><a href="notifications.html">Desktop Notifications</a></li >

113 <li><a href="omnibox.html">Omnibox</a></li>

114 <li><a href="options.html">Options Pages</a></li>

115 <li><a href="override.html">Override Pages</a></li>

116 <li><a href="pageAction.html">Page Actions</a></li>

117 </ul>

118 </li>

119 <li>Browser Interaction

120 <ul>

121 <li><a href="bookmarks.html">Bookmarks</a></li>

122 <li><a href="cookies.html">Cookies</a></li>

123 <li><a href="devtools.html">Developer Tools</a></li>

124 <li><a href="events.html">Events</a></li>

125 <li><a href="history.html">History</a></li>

126 <li><a href="management.html">Management</a></li>

127 <li class="leftNavSelected">Tabs</li>

128 <li><a href="windows.html">Windows</a></li>

129 </ul>

130 </li>

131 <li>Implementation

132 <ul>

133 <li><a href="a11y.html">Accessibility</a></li>

134 <li><a href="background_pages.html">Background Pages</a></li>

135 <li><a href="content_scripts.html">Content Scripts</a></li>

136 <li><a href="xhr.html">Cross-Origin XHR</a></li>

137 <li><a href="i18n.html">Internationalization</a></li>

138 <li><a href="messaging.html">Message Passing</a></li>

139 <li><a href="permissions.html">Optional Permissions</a></li>

140 <li><a href="npapi.html">NPAPI Plugins</a></li>

141 </ul>

142 </li>

143 <li>Finishing

144 <ul>

145 <li><a href="hosting.html">Hosting</a></li>

146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>

147 </ul>

148 </li>

149 </ul>

150 </li>

151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

152 <li><h2><a href="tutorials.html">Tutorials</a></h2>

153 <ul>

154 <li><a href="tut_debugging.html">Debugging</a></li>

155 <li><a href="tut_analytics.html">Google Analytics</a></li>

156 <li><a href="tut_oauth.html">OAuth</a></li>

157 </ul>

158 </li>

159 <li><h2>Reference</h2>

160 <ul>

161 <li>Formats

162 <ul>

163 <li><a href="manifest.html">Manifest Files</a></li>

164 <li><a href="match_patterns.html">Match Patterns</a></li>

165 </ul>

166 </li>

167 <li><a href="permission_warnings.html">Permission Warnings</a></li >

168 <li><a href="api_index.html">chrome.* APIs</a></li>

169 <li><a href="api_other.html">Other APIs</a></li>

170 </ul>

171 </li>

172 <li><h2><a href="samples.html">Samples</a></h2></li>

173 <div class="line"> </div>

174 <li><h2>More</h2>

175 <ul>

176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>

177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>

178 <li><a href="themes.html">Themes</a></li>

179 </ul>

180 </li>

181 </ul>

182 </div>

183 <script>

184 initToggles();

185 </script>

186 <div class="g-unit" id="gc-pagecontent">

187 <div id="pageTitle">

188 <h1 class="page_title">Tabs</h1>

189 </div>

190 <!-- TABLE OF CONTENTS -->

191 <div id="toc">

192 <h2>Contents</h2>

193 <ol>

194 <li>

195 <a href="#manifest">Manifest</a>

196 <ol>

197 </ol>

198 </li><li>

199 <a href="#examples"> Examples </a>

200 <ol>

201 </ol>

202 </li>

203 <li>

204 <a href="#apiReference">API reference: chrome.tabs</a>

205 <ol>

206 <li>

207 <a href="#global-methods">Methods</a>

208 <ol>

209 <li>

210 <a href="#method-captureVisibleTab">captureVisibleTab</a>

211 </li><li>

212 <a href="#method-connect">connect</a>

213 </li><li>

214 <a href="#method-create">create</a>

215 </li><li>

216 <a href="#method-detectLanguage">detectLanguage</a>

217 </li><li>

218 <a href="#method-executeScript">executeScript</a>

219 </li><li>

220 <a href="#method-get">get</a>

221 </li><li>

222 <a href="#method-getCurrent">getCurrent</a>

223 </li><li>

224 <a href="#method-highlight">highlight</a>

225 </li><li>

226 <a href="#method-insertCSS">insertCSS</a>

227 </li><li>

228 <a href="#method-move">move</a>

229 </li><li>

230 <a href="#method-query">query</a>

231 </li><li>

232 <a href="#method-reload">reload</a>

233 </li><li>

234 <a href="#method-remove">remove</a>

235 </li><li>

236 <a href="#method-sendMessage">sendMessage</a>

237 </li><li>

238 <a href="#method-update">update</a>

239 </li>

240 </ol>

241 </li>

242 <li>

243 <a href="#global-events">Events</a>

244 <ol>

245 <li>

246 <a href="#event-onActivated">onActivated</a>

247 </li><li>

248 <a href="#event-onAttached">onAttached</a>

249 </li><li>

250 <a href="#event-onCreated">onCreated</a>

251 </li><li>

252 <a href="#event-onDetached">onDetached</a>

253 </li><li>

254 <a href="#event-onHighlighted">onHighlighted</a>

255 </li><li>

256 <a href="#event-onMoved">onMoved</a>

257 </li><li>

258 <a href="#event-onRemoved">onRemoved</a>

259 </li><li>

260 <a href="#event-onUpdated">onUpdated</a>

261 </li>

262 </ol>

263 </li>

264 <li>

265 <a href="#types">Types</a>

266 <ol>

267 <li>

268 <a href="#type-Tab">Tab</a>

269 <ol>

270 </ol>

271 </li>

272 </ol>

273 </li>

274 </ol>

275 </li>

276 </ol>

277 </div>

278 <!-- /TABLE OF CONTENTS -->

279 <!-- Standard content lead-in for experimental API pages -->

280 <!-- STATIC CONTENT PLACEHOLDER -->

281 <div id="static"><div id="pageData-name" class="pageData">Tabs</div>

282 <!-- BEGIN AUTHORED CONTENT -->

283 <p id="classSummary">

284 Use the <code>chrome.tabs</code> module

285 to interact with the browser's tab system.

286 You can use this module to

287 create, modify, and rearrange tabs in the browser.

288 </p>

289 <img src="images/tabs.png" width="323" height="50" alt="Two tabs in a window">

290 <h2 id="manifest">Manifest</h2>

291 <p>

292 Almost all <code>chrome.tabs</code> methods require you to

293 declare the "tabs" permission

294 in the <a href="manifest.html">extension manifest</a>.

295 For example:

296 </p>

297 <pre>{

298 "name": "My extension",

299 ...

300 <b>"permissions": [

301 "tabs"

302 ]</b>,

303 ...

304 }</pre>

305 <p>

306 Three methods (<a href="#method-create"><code>create</code></a>,

307 <a href="#method-update"><code>update</code></a> and

308 <a href="#method-remove"><code>remove</code></a>) and one event

309 (<a href="#event-onRemoved"><code>onRemoved</code></a>) don't require the "tabs"

310 permission.

311 </p>

312 <h2 id="examples"> Examples </h2>

313 <p>

314 You can find simple examples of using the tabs module in the

315 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension s/docs/examples/api/tabs/">examples/api/tabs</a>

316 directory.

317 For other examples and for help in viewing the source code, see

318 <a href="samples.html">Samples</a>.

319 </p>

320 <!-- END AUTHORED CONTENT -->

321 </div>

322 <!-- API PAGE -->

323 <div class="apiPage">

324 <a name="apiReference"></a>

325 <h2>API reference: chrome.tabs</h2>

326 <!-- PROPERTIES -->

327 <!-- /apiGroup -->

328 <!-- METHODS -->

329 <div id="methodsTemplate" class="apiGroup">

330 <a name="global-methods"></a>

331 <h3>Methods</h3>

332 <!-- iterates over all functions -->

333 <div class="apiItem">

334 <a name="method-captureVisibleTab"></a> <!-- method-anchor -->

335 <h4>captureVisibleTab</h4>

336 <div class="summary">

337 <!-- Note: intentionally longer 80 columns -->

338 <span>chrome.tabs.captureVisibleTab</span>(<span class="option al"><span>integer</span>

339 <var><span>windowId</span></var></span><span class="option al"><span>, </span><span>object</span>

340 <var><span>options</span></var></span><span class="null">< span>, </span><span>function</span>

341 <var><span>callback</span></var></span>)</div>

342 <div class="description">

343 <p>Captures the visible area of the currently active tab in the specified window. You must have <a href="manifest.html#permissions">host permiss ion</a> for the URL displayed by the tab.</p>

344 <!-- PARAMETERS -->

345 <h4>Parameters</h4>

346 <dl>

347 <div>

348 <div>

349 <dt>

350 <var>windowId</var>

351 <em>

352 <!-- TYPE -->

353 <div style="display:inline">

354 (

355 <span class="optional">optional</span>

356 <span id="typeTemplate">

357 <span>

358 <span>integer</span>

359 </span>

360 </span>

361 )

362 </div>

363 </em>

364 </dt>

365 <dd>The target window. Defaults to the <a href="windows.html#current-w indow">current window</a>.</dd>

366 <!-- OBJECT PROPERTIES -->

367 <!-- OBJECT METHODS -->

368 <!-- OBJECT EVENT FIELDS -->

369 <!-- FUNCTION PARAMETERS -->

370 </div>

371 </div><div>

372 <div>

373 <dt>

374 <var>options</var>

375 <em>

376 <!-- TYPE -->

377 <div style="display:inline">

378 (

379 <span class="optional">optional</span>

380 <span id="typeTemplate">

381 <span>

382 <span>object</span>

383 </span>

384 </span>

385 )

386 </div>

387 </em>

388 </dt>

389 <dd>Set parameters of image capture, such as the format of the resulti ng image.</dd>

390 <!-- OBJECT PROPERTIES -->

391 <dd>

392 <dl>

393 <div>

394 <div>

395 <dt>

396 <var>format</var>

397 <em>

398 <!-- TYPE -->

399 <div style="display:inline">

400 (

401 <span class="optional">optional</span>

402 <span class="enum">enumerated</span>

403 <span id="typeTemplate">

404 <span>

405 <span>string</span>

406 <span>["jpeg", "png"]</span>

407 </span>

408 </span>

409 )

410 </div>

411 </em>

412 </dt>

413 <dd>The format of the resulting image. Default is jpeg.</dd>

414 <!-- OBJECT PROPERTIES -->

415 <!-- OBJECT METHODS -->

416 <!-- OBJECT EVENT FIELDS -->

417 <!-- FUNCTION PARAMETERS -->

418 </div>

419 </div><div>

420 <div>

421 <dt>

422 <var>quality</var>

423 <em>

424 <!-- TYPE -->

425 <div style="display:inline">

426 (

427 <span class="optional">optional</span>

428 <span id="typeTemplate">

429 <span>

430 <span>integer</span>

431 </span>

432 </span>

433 )

434 </div>

435 </em>

436 </dt>

437 <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>

438 <!-- OBJECT PROPERTIES -->

439 <!-- OBJECT METHODS -->

440 <!-- OBJECT EVENT FIELDS -->

441 <!-- FUNCTION PARAMETERS -->

442 </div>

443 </div>

444 </dl>

445 </dd>

446 <!-- OBJECT METHODS -->

447 <!-- OBJECT EVENT FIELDS -->

448 <!-- FUNCTION PARAMETERS -->

449 </div>

450 </div><div>

451 <div>

452 <dt>

453 <var>callback</var>

454 <em>

455 <!-- TYPE -->

456 <div style="display:inline">

457 (

458 <span id="typeTemplate">

459 <span>

460 <span>function</span>

461 </span>

462 </span>

463 )

464 </div>

465 </em>

466 </dt>

467 <dd class="todo">

468 Undocumented.

469 </dd>

470 <!-- OBJECT PROPERTIES -->

471 <!-- OBJECT METHODS -->

472 <!-- OBJECT EVENT FIELDS -->

473 <!-- FUNCTION PARAMETERS -->

474 </div>

475 </div>

476 </dl>

477 <!-- RETURNS -->

478 <dl>

479 </dl>

480 <!-- CALLBACK -->

481 <div>

482 <div>

483 <h4>Callback function</h4>

484 <p>

485 The <em>callback</em> parameter should specify a function

486 that looks like this:

487 </p>

488 <!-- Note: intentionally longer 80 columns -->

489 <pre>function(<span>string dataUrl</span>) <span class="subdue d">{...}</span>;</pre>

490 <dl>

491 <div>

492 <div>

493 <dt>

494 <var>dataUrl</var>

495 <em>

496 <!-- TYPE -->

497 <div style="display:inline">

498 (

499 <span id="typeTemplate">

500 <span>

501 <span>string</span>

502 </span>

503 </span>

504 )

505 </div>

506 </em>

507 </dt>

508 <dd>A data URL which encodes an image of the visible area of the captu red tab. May be assigned to the 'src' property of an HTML Image element for disp lay.</dd>

509 <!-- OBJECT PROPERTIES -->

510 <!-- OBJECT METHODS -->

511 <!-- OBJECT EVENT FIELDS -->

512 <!-- FUNCTION PARAMETERS -->

513 </div>

514 </div>

515 </dl>

516 </div>

517 </div>

518 <!-- MIN_VERSION -->

519 </div> <!-- /description -->

520 </div><div class="apiItem">

521 <a name="method-connect"></a> <!-- method-anchor -->

522 <h4>connect</h4>

523 <div class="summary"><span>extension.Port</span>

524 <!-- Note: intentionally longer 80 columns -->

525 <span>chrome.tabs.connect</span>(<span class="null"><span>inte ger</span>

526 <var><span>tabId</span></var></span><span class="optional" ><span>, </span><span>object</span>

527 <var><span>connectInfo</span></var></span>)</div>

528 <div class="description">

529 <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 extens ion. For more details, see <a href="content_scripts.html#messaging">Content Scri pt Messaging</a>.</p>

530 <!-- PARAMETERS -->

531 <h4>Parameters</h4>

532 <dl>

533 <div>

534 <div>

535 <dt>

536 <var>tabId</var>

537 <em>

538 <!-- TYPE -->

539 <div style="display:inline">

540 (

541 <span id="typeTemplate">

542 <span>

543 <span>integer</span>

544 </span>

545 </span>

546 )

547 </div>

548 </em>

549 </dt>

550 <dd class="todo">

551 Undocumented.

552 </dd>

553 <!-- OBJECT PROPERTIES -->

554 <!-- OBJECT METHODS -->

555 <!-- OBJECT EVENT FIELDS -->

556 <!-- FUNCTION PARAMETERS -->

557 </div>

558 </div><div>

559 <div>

560 <dt>

561 <var>connectInfo</var>

562 <em>

563 <!-- TYPE -->

564 <div style="display:inline">

565 (

566 <span class="optional">optional</span>

567 <span id="typeTemplate">

568 <span>

569 <span>object</span>

570 </span>

571 </span>

572 )

573 </div>

574 </em>

575 </dt>

576 <dd class="todo">

577 Undocumented.

578 </dd>

579 <!-- OBJECT PROPERTIES -->

580 <dd>

581 <dl>

582 <div>

583 <div>

584 <dt>

585 <var>name</var>

586 <em>

587 <!-- TYPE -->

588 <div style="display:inline">

589 (

590 <span class="optional">optional</span>

591 <span id="typeTemplate">

592 <span>

593 <span>string</span>

594 </span>

595 </span>

596 )

597 </div>

598 </em>

599 </dt>

600 <dd>Will be passed into onConnect for content scripts that are listeni ng for the connection event.</dd>

601 <!-- OBJECT PROPERTIES -->

602 <!-- OBJECT METHODS -->

603 <!-- OBJECT EVENT FIELDS -->

604 <!-- FUNCTION PARAMETERS -->

605 </div>

606 </div>

607 </dl>

608 </dd>

609 <!-- OBJECT METHODS -->

610 <!-- OBJECT EVENT FIELDS -->

611 <!-- FUNCTION PARAMETERS -->

612 </div>

613 </div>

614 </dl>

615 <!-- RETURNS -->

616 <h4>Returns</h4>

617 <dl>

618 <div>

619 <div>

620 <dt>

621 <em>

622 <!-- TYPE -->

623 <div style="display:inline">

624 (

625 <span id="typeTemplate">

626 <span>

627 <a>extension.Port</a>

628 </span>

629 </span>

630 )

631 </div>

632 </em>

633 </dt>

634 <dd>A port that can be used to communicate with the content scripts ru nning in the specified tab. The port's <a href="extension.html#type-Port">onDisc onnect</a> event is fired if the tab closes or does not exist. </dd>

635 <!-- OBJECT PROPERTIES -->

636 <!-- OBJECT METHODS -->

637 <!-- OBJECT EVENT FIELDS -->

638 <!-- FUNCTION PARAMETERS -->

639 </div>

640 </div>

641 </dl>

642 <!-- CALLBACK -->

643 <!-- MIN_VERSION -->

644 </div> <!-- /description -->

645 </div><div class="apiItem">

646 <a name="method-create"></a> <!-- method-anchor -->

647 <h4>create</h4>

648 <div class="summary">

649 <!-- Note: intentionally longer 80 columns -->

650 <span>chrome.tabs.create</span>(<span class="null"><span>objec t</span>

651 <var><span>createProperties</span></var></span><span class ="optional"><span>, </span><span>function</span>

652 <var><span>callback</span></var></span>)</div>

653 <div class="description">

654 <p>Creates a new tab. Note: This function can be used without re questing the 'tabs' permission in the manifest.</p>

655 <!-- PARAMETERS -->

656 <h4>Parameters</h4>

657 <dl>

658 <div>

659 <div>

660 <dt>

661 <var>createProperties</var>

662 <em>

663 <!-- TYPE -->

664 <div style="display:inline">

665 (

666 <span id="typeTemplate">

667 <span>

668 <span>object</span>

669 </span>

670 </span>

671 )

672 </div>

673 </em>

674 </dt>

675 <dd class="todo">

676 Undocumented.

677 </dd>

678 <!-- OBJECT PROPERTIES -->

679 <dd>

680 <dl>

681 <div>

682 <div>

683 <dt>

684 <var>windowId</var>

685 <em>

686 <!-- TYPE -->

687 <div style="display:inline">

688 (

689 <span class="optional">optional</span>

690 <span id="typeTemplate">

691 <span>

692 <span>integer</span>

693 </span>

694 </span>

695 )

696 </div>

697 </em>

698 </dt>

699 <dd>The window to create the new tab in. Defaults to the <a href="wind ows.html#current-window">current window</a>.</dd>

700 <!-- OBJECT PROPERTIES -->

701 <!-- OBJECT METHODS -->

702 <!-- OBJECT EVENT FIELDS -->

703 <!-- FUNCTION PARAMETERS -->

704 </div>

705 </div><div>

706 <div>

707 <dt>

708 <var>index</var>

709 <em>

710 <!-- TYPE -->

711 <div style="display:inline">

712 (

713 <span class="optional">optional</span>

714 <span id="typeTemplate">

715 <span>

716 <span>integer</span>

717 </span>

718 </span>

719 )

720 </div>

721 </em>

722 </dt>

723 <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>

724 <!-- OBJECT PROPERTIES -->

725 <!-- OBJECT METHODS -->

726 <!-- OBJECT EVENT FIELDS -->

727 <!-- FUNCTION PARAMETERS -->

728 </div>

729 </div><div>

730 <div>

731 <dt>

732 <var>url</var>

733 <em>

734 <!-- TYPE -->

735 <div style="display:inline">

736 (

737 <span class="optional">optional</span>

738 <span id="typeTemplate">

739 <span>

740 <span>string</span>

741 </span>

742 </span>

743 )

744 </div>

745 </em>

746 </dt>

747 <dd>The URL to navigate the tab to initially. Fully-qualified URLs mus t include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relativ e URLs will be relative to the current page within the extension. Defaults to th e New Tab Page.</dd>

748 <!-- OBJECT PROPERTIES -->

749 <!-- OBJECT METHODS -->

750 <!-- OBJECT EVENT FIELDS -->

751 <!-- FUNCTION PARAMETERS -->

752 </div>

753 </div><div>

754 <div>

755 <dt>

756 <var>active</var>

757 <em>

758 <!-- TYPE -->

759 <div style="display:inline">

760 (

761 <span class="optional">optional</span>

762 <span id="typeTemplate">

763 <span>

764 <span>boolean</span>

765 </span>

766 </span>

767 )

768 </div>

769 </em>

770 </dt>

771 <dd>Whether the tab should become the active tab in the window. Defaul ts to <var>true</var></dd>

772 <!-- OBJECT PROPERTIES -->

773 <!-- OBJECT METHODS -->

774 <!-- OBJECT EVENT FIELDS -->

775 <!-- FUNCTION PARAMETERS -->

776 </div>

777 </div><div>

778 <div>

779 <dt>

780 <var>pinned</var>

781 <em>

782 <!-- TYPE -->

783 <div style="display:inline">

784 (

785 <span class="optional">optional</span>

786 <span id="typeTemplate">

787 <span>

788 <span>boolean</span>

789 </span>

790 </span>

791 )

792 </div>

793 </em>

794 </dt>

795 <dd>Whether the tab should be pinned. Defaults to <var>false</var></dd >

796 <!-- OBJECT PROPERTIES -->

797 <!-- OBJECT METHODS -->

798 <!-- OBJECT EVENT FIELDS -->

799 <!-- FUNCTION PARAMETERS -->

800 </div>

801 </div><div>

802 <div>

803 <dt>

804 <var>openerTabId</var>

805 <em>

806 <!-- TYPE -->

807 <div style="display:inline">

808 (

809 <span class="optional">optional</span>

810 <span id="typeTemplate">

811 <span>

812 <span>integer</span>

813 </span>

814 </span>

815 )

816 </div>

817 </em>

818 </dt>

819 <dd>The ID of the tab that opened this tab. If specified, the opener t ab must be in the same window as the newly created tab.</dd>

820 <!-- OBJECT PROPERTIES -->

821 <!-- OBJECT METHODS -->

822 <!-- OBJECT EVENT FIELDS -->

823 <!-- FUNCTION PARAMETERS -->

824 </div>

825 </div>

826 </dl>

827 </dd>

828 <!-- OBJECT METHODS -->

829 <!-- OBJECT EVENT FIELDS -->

830 <!-- FUNCTION PARAMETERS -->

831 </div>

832 </div><div>

833 <div>

834 <dt>

835 <var>callback</var>

836 <em>

837 <!-- TYPE -->

838 <div style="display:inline">

839 (

840 <span class="optional">optional</span>

841 <span id="typeTemplate">

842 <span>

843 <span>function</span>

844 </span>

845 </span>

846 )

847 </div>

848 </em>

849 </dt>

850 <dd class="todo">

851 Undocumented.

852 </dd>

853 <!-- OBJECT PROPERTIES -->

854 <!-- OBJECT METHODS -->

855 <!-- OBJECT EVENT FIELDS -->

856 <!-- FUNCTION PARAMETERS -->

857 </div>

858 </div>

859 </dl>

860 <!-- RETURNS -->

861 <dl>

862 </dl>

863 <!-- CALLBACK -->

864 <div>

865 <div>

866 <h4>Callback function</h4>

867 <p>

868 If you specify the <em>callback</em> parameter, it should

869 specify a function that looks like this:

870 </p>

871 <!-- Note: intentionally longer 80 columns -->

872 <pre>function(<span>Tab tab</span>) <span class="subdued">{... }</span>;</pre>

873 <dl>

874 <div>

875 <div>

876 <dt>

877 <var>tab</var>

878 <em>

879 <!-- TYPE -->

880 <div style="display:inline">

881 (

882 <span id="typeTemplate">

883 <span>

884 <a href="tabs.html#type-Tab">Tab</a>

885 </span>

886 </span>

887 )

888 </div>

889 </em>

890 </dt>

891 <dd>Details about the created tab. Will contain the ID of the new tab. </dd>

892 <!-- OBJECT PROPERTIES -->

893 <!-- OBJECT METHODS -->

894 <!-- OBJECT EVENT FIELDS -->

895 <!-- FUNCTION PARAMETERS -->

896 </div>

897 </div>

898 </dl>

899 </div>

900 </div>

901 <!-- MIN_VERSION -->

902 </div> <!-- /description -->

903 </div><div class="apiItem">

904 <a name="method-detectLanguage"></a> <!-- method-anchor -->

905 <h4>detectLanguage</h4>

906 <div class="summary">

907 <!-- Note: intentionally longer 80 columns -->

908 <span>chrome.tabs.detectLanguage</span>(<span class="optional" ><span>integer</span>

909 <var><span>tabId</span></var></span><span class="null"><sp an>, </span><span>function</span>

910 <var><span>callback</span></var></span>)</div>

911 <div class="description">

912 <p>Detects the primary language of the content in a tab.</p>

913 <!-- PARAMETERS -->

914 <h4>Parameters</h4>

915 <dl>

916 <div>

917 <div>

918 <dt>

919 <var>tabId</var>

920 <em>

921 <!-- TYPE -->

922 <div style="display:inline">

923 (

924 <span class="optional">optional</span>

925 <span id="typeTemplate">

926 <span>

927 <span>integer</span>

928 </span>

929 </span>

930 )

931 </div>

932 </em>

933 </dt>

934 <dd>Defaults to the active tab of the <a href="windows.html#current-wi ndow">current window</a>.</dd>

935 <!-- OBJECT PROPERTIES -->

936 <!-- OBJECT METHODS -->

937 <!-- OBJECT EVENT FIELDS -->

938 <!-- FUNCTION PARAMETERS -->

939 </div>

940 </div><div>

941 <div>

942 <dt>

943 <var>callback</var>

944 <em>

945 <!-- TYPE -->

946 <div style="display:inline">

947 (

948 <span id="typeTemplate">

949 <span>

950 <span>function</span>

951 </span>

952 </span>

953 )

954 </div>

955 </em>

956 </dt>

957 <dd class="todo">

958 Undocumented.

959 </dd>

960 <!-- OBJECT PROPERTIES -->

961 <!-- OBJECT METHODS -->

962 <!-- OBJECT EVENT FIELDS -->

963 <!-- FUNCTION PARAMETERS -->

964 </div>

965 </div>

966 </dl>

967 <!-- RETURNS -->

968 <dl>

969 </dl>

970 <!-- CALLBACK -->

971 <div>

972 <div>

973 <h4>Callback function</h4>

974 <p>

975 The <em>callback</em> parameter should specify a function

976 that looks like this:

977 </p>

978 <!-- Note: intentionally longer 80 columns -->

979 <pre>function(<span>string language</span>) <span class="subdu ed">{...}</span>;</pre>

980 <dl>

981 <div>

982 <div>

983 <dt>

984 <var>language</var>

985 <em>

986 <!-- TYPE -->

987 <div style="display:inline">

988 (

989 <span id="typeTemplate">

990 <span>

991 <span>string</span>

992 </span>

993 </span>

994 )

995 </div>

996 </em>

997 </dt>

998 <dd>An ISO language code such as <code>en</code> or <code>fr</code>. F or a complete list of languages supported by this method, see <a href="http://sr c.chromium.org/viewvc/chrome/trunk/src/third_party/cld/languages/internal/langua ges.cc">kLanguageInfoTable</a>. The 2nd to 4th columns will be checked and the f irst 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>

999 <!-- OBJECT PROPERTIES -->

1000 <!-- OBJECT METHODS -->

1001 <!-- OBJECT EVENT FIELDS -->

1002 <!-- FUNCTION PARAMETERS -->

1003 </div>

1004 </div>

1005 </dl>

1006 </div>

1007 </div>

1008 <!-- MIN_VERSION -->

1009 </div> <!-- /description -->

1010 </div><div class="apiItem">

1011 <a name="method-executeScript"></a> <!-- method-anchor -->

1012 <h4>executeScript</h4>

1013 <div class="summary">

1014 <!-- Note: intentionally longer 80 columns -->

1015 <span>chrome.tabs.executeScript</span>(<span class="optional"> <span>integer</span>

1016 <var><span>tabId</span></var></span><span class="null"><sp an>, </span><span>object</span>

1017 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>

1018 <var><span>callback</span></var></span>)</div>

1019 <div class="description">

1020 <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>

1021 <!-- PARAMETERS -->

1022 <h4>Parameters</h4>

1023 <dl>

1024 <div>

1025 <div>

1026 <dt>

1027 <var>tabId</var>

1028 <em>

1029 <!-- TYPE -->

1030 <div style="display:inline">

1031 (

1032 <span class="optional">optional</span>

1033 <span id="typeTemplate">

1034 <span>

1035 <span>integer</span>

1036 </span>

1037 </span>

1038 )

1039 </div>

1040 </em>

1041 </dt>

1042 <dd>The ID of the tab in which to run the script; defaults to the acti ve tab of the current window.</dd>

1043 <!-- OBJECT PROPERTIES -->

1044 <!-- OBJECT METHODS -->

1045 <!-- OBJECT EVENT FIELDS -->

1046 <!-- FUNCTION PARAMETERS -->

1047 </div>

1048 </div><div>

1049 <div>

1050 <dt>

1051 <var>details</var>

1052 <em>

1053 <!-- TYPE -->

1054 <div style="display:inline">

1055 (

1056 <span id="typeTemplate">

1057 <span>

1058 <span>object</span>

1059 </span>

1060 </span>

1061 )

1062 </div>

1063 </em>

1064 </dt>

1065 <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>

1066 <!-- OBJECT PROPERTIES -->

1067 <dd>

1068 <dl>

1069 <div>

1070 <div>

1071 <dt>

1072 <var>code</var>

1073 <em>

1074 <!-- TYPE -->

1075 <div style="display:inline">

1076 (

1077 <span class="optional">optional</span>

1078 <span id="typeTemplate">

1079 <span>

1080 <span>string</span>

1081 </span>

1082 </span>

1083 )

1084 </div>

1085 </em>

1086 </dt>

1087 <dd>JavaScript code to execute.</dd>

1088 <!-- OBJECT PROPERTIES -->

1089 <!-- OBJECT METHODS -->

1090 <!-- OBJECT EVENT FIELDS -->

1091 <!-- FUNCTION PARAMETERS -->

1092 </div>

1093 </div><div>

1094 <div>

1095 <dt>

1096 <var>file</var>

1097 <em>

1098 <!-- TYPE -->

1099 <div style="display:inline">

1100 (

1101 <span class="optional">optional</span>

1102 <span id="typeTemplate">

1103 <span>

1104 <span>string</span>

1105 </span>

1106 </span>

1107 )

1108 </div>

1109 </em>

1110 </dt>

1111 <dd>JavaScript file to execute.</dd>

1112 <!-- OBJECT PROPERTIES -->

1113 <!-- OBJECT METHODS -->

1114 <!-- OBJECT EVENT FIELDS -->

1115 <!-- FUNCTION PARAMETERS -->

1116 </div>

1117 </div><div>

1118 <div>

1119 <dt>

1120 <var>allFrames</var>

1121 <em>

1122 <!-- TYPE -->

1123 <div style="display:inline">

1124 (

1125 <span class="optional">optional</span>

1126 <span id="typeTemplate">

1127 <span>

1128 <span>boolean</span>

1129 </span>

1130 </span>

1131 )

1132 </div>

1133 </em>

1134 </dt>

1135 <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 to p main frame.</dd>

1136 <!-- OBJECT PROPERTIES -->

1137 <!-- OBJECT METHODS -->

1138 <!-- OBJECT EVENT FIELDS -->

1139 <!-- FUNCTION PARAMETERS -->

1140 </div>

1141 </div><div>

1142 <div>

1143 <dt>

1144 <var>runAt</var>

1145 <em>

1146 <!-- TYPE -->

1147 <div style="display:inline">

1148 (

1149 <span class="optional">optional</span>

1150 <span class="enum">enumerated</span>

1151 <span id="typeTemplate">

1152 <span>

1153 <span>string</span>

1154 <span>["document_start", "document_end", "document_idle" ]</span>

1155 </span>

1156 </span>

1157 )

1158 </div>

1159 </em>

1160 </dt>

1161 <dd>The soonest that the script will be injected into the tab. Default s to "document_idle".</dd>

1162 <!-- OBJECT PROPERTIES -->

1163 <!-- OBJECT METHODS -->

1164 <!-- OBJECT EVENT FIELDS -->

1165 <!-- FUNCTION PARAMETERS -->

1166 </div>

1167 </div>

1168 </dl>

1169 </dd>

1170 <!-- OBJECT METHODS -->

1171 <!-- OBJECT EVENT FIELDS -->

1172 <!-- FUNCTION PARAMETERS -->

1173 </div>

1174 </div><div>

1175 <div>

1176 <dt>

1177 <var>callback</var>

1178 <em>

1179 <!-- TYPE -->

1180 <div style="display:inline">

1181 (

1182 <span class="optional">optional</span>

1183 <span id="typeTemplate">

1184 <span>

1185 <span>function</span>

1186 </span>

1187 </span>

1188 )

1189 </div>

1190 </em>

1191 </dt>

1192 <dd>Called after all the JavaScript has been executed.</dd>

1193 <!-- OBJECT PROPERTIES -->

1194 <!-- OBJECT METHODS -->

1195 <!-- OBJECT EVENT FIELDS -->

1196 <!-- FUNCTION PARAMETERS -->

1197 </div>

1198 </div>

1199 </dl>

1200 <!-- RETURNS -->

1201 <dl>

1202 </dl>

1203 <!-- CALLBACK -->

1204 <div>

1205 <div>

1206 <h4>Callback function</h4>

1207 <p>

1208 If you specify the <em>callback</em> parameter, it should

1209 specify a function that looks like this:

1210 </p>

1211 <!-- Note: intentionally longer 80 columns -->

1212 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>

1213 <dl>

1214 </dl>

1215 </div>

1216 </div>

1217 <!-- MIN_VERSION -->

1218 </div> <!-- /description -->

1219 </div><div class="apiItem">

1220 <a name="method-get"></a> <!-- method-anchor -->

1221 <h4>get</h4>

1222 <div class="summary">

1223 <!-- Note: intentionally longer 80 columns -->

1224 <span>chrome.tabs.get</span>(<span class="null"><span>integer< /span>

1225 <var><span>tabId</span></var></span><span class="null"><sp an>, </span><span>function</span>

1226 <var><span>callback</span></var></span>)</div>

1227 <div class="description">

1228 <p>Retrieves details about the specified tab.</p>

1229 <!-- PARAMETERS -->

1230 <h4>Parameters</h4>

1231 <dl>

1232 <div>

1233 <div>

1234 <dt>

1235 <var>tabId</var>

1236 <em>

1237 <!-- TYPE -->

1238 <div style="display:inline">

1239 (

1240 <span id="typeTemplate">

1241 <span>

1242 <span>integer</span>

1243 </span>

1244 </span>

1245 )

1246 </div>

1247 </em>

1248 </dt>

1249 <dd class="todo">

1250 Undocumented.

1251 </dd>

1252 <!-- OBJECT PROPERTIES -->

1253 <!-- OBJECT METHODS -->

1254 <!-- OBJECT EVENT FIELDS -->

1255 <!-- FUNCTION PARAMETERS -->

1256 </div>

1257 </div><div>

1258 <div>

1259 <dt>

1260 <var>callback</var>

1261 <em>

1262 <!-- TYPE -->

1263 <div style="display:inline">

1264 (

1265 <span id="typeTemplate">

1266 <span>

1267 <span>function</span>

1268 </span>

1269 </span>

1270 )

1271 </div>

1272 </em>

1273 </dt>

1274 <dd class="todo">

1275 Undocumented.

1276 </dd>

1277 <!-- OBJECT PROPERTIES -->

1278 <!-- OBJECT METHODS -->

1279 <!-- OBJECT EVENT FIELDS -->

1280 <!-- FUNCTION PARAMETERS -->

1281 </div>

1282 </div>

1283 </dl>

1284 <!-- RETURNS -->

1285 <dl>

1286 </dl>

1287 <!-- CALLBACK -->

1288 <div>

1289 <div>

1290 <h4>Callback function</h4>

1291 <p>

1292 The <em>callback</em> parameter should specify a function

1293 that looks like this:

1294 </p>

1295 <!-- Note: intentionally longer 80 columns -->

1296 <pre>function(<span>Tab tab</span>) <span class="subdued">{... }</span>;</pre>

1297 <dl>

1298 <div>

1299 <div>

1300 <dt>

1301 <var>tab</var>

1302 <em>

1303 <!-- TYPE -->

1304 <div style="display:inline">

1305 (

1306 <span id="typeTemplate">

1307 <span>

1308 <a href="tabs.html#type-Tab">Tab</a>

1309 </span>

1310 </span>

1311 )

1312 </div>

1313 </em>

1314 </dt>

1315 <dd class="todo">

1316 Undocumented.

1317 </dd>

1318 <!-- OBJECT PROPERTIES -->

1319 <!-- OBJECT METHODS -->

1320 <!-- OBJECT EVENT FIELDS -->

1321 <!-- FUNCTION PARAMETERS -->

1322 </div>

1323 </div>

1324 </dl>

1325 </div>

1326 </div>

1327 <!-- MIN_VERSION -->

1328 </div> <!-- /description -->

1329 </div><div class="apiItem">

1330 <a name="method-getCurrent"></a> <!-- method-anchor -->

1331 <h4>getCurrent</h4>

1332 <div class="summary">

1333 <!-- Note: intentionally longer 80 columns -->

1334 <span>chrome.tabs.getCurrent</span>(<span class="null"><span>f unction</span>

1335 <var><span>callback</span></var></span>)</div>

1336 <div class="description">

1337 <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 p opup view).</p>

1338 <!-- PARAMETERS -->

1339 <h4>Parameters</h4>

1340 <dl>

1341 <div>

1342 <div>

1343 <dt>

1344 <var>callback</var>

1345 <em>

1346 <!-- TYPE -->

1347 <div style="display:inline">

1348 (

1349 <span id="typeTemplate">

1350 <span>

1351 <span>function</span>

1352 </span>

1353 </span>

1354 )

1355 </div>

1356 </em>

1357 </dt>

1358 <dd class="todo">

1359 Undocumented.

1360 </dd>

1361 <!-- OBJECT PROPERTIES -->

1362 <!-- OBJECT METHODS -->

1363 <!-- OBJECT EVENT FIELDS -->

1364 <!-- FUNCTION PARAMETERS -->

1365 </div>

1366 </div>

1367 </dl>

1368 <!-- RETURNS -->

1369 <dl>

1370 </dl>

1371 <!-- CALLBACK -->

1372 <div>

1373 <div>

1374 <h4>Callback function</h4>

1375 <p>

1376 The <em>callback</em> parameter should specify a function

1377 that looks like this:

1378 </p>

1379 <!-- Note: intentionally longer 80 columns -->

1380 <pre>function(<span>Tab tab</span>) <span class="subdued">{... }</span>;</pre>

1381 <dl>

1382 <div>

1383 <div>

1384 <dt>

1385 <var>tab</var>

1386 <em>

1387 <!-- TYPE -->

1388 <div style="display:inline">

1389 (

1390 <span class="optional">optional</span>

1391 <span id="typeTemplate">

1392 <span>

1393 <a href="tabs.html#type-Tab">Tab</a>

1394 </span>

1395 </span>

1396 )

1397 </div>

1398 </em>

1399 </dt>

1400 <dd class="todo">

1401 Undocumented.

1402 </dd>

1403 <!-- OBJECT PROPERTIES -->

1404 <!-- OBJECT METHODS -->

1405 <!-- OBJECT EVENT FIELDS -->

1406 <!-- FUNCTION PARAMETERS -->

1407 </div>

1408 </div>

1409 </dl>

1410 </div>

1411 </div>

1412 <!-- MIN_VERSION -->

1413 </div> <!-- /description -->

1414 </div><div class="apiItem">

1415 <a name="method-highlight"></a> <!-- method-anchor -->

1416 <h4>highlight</h4>

1417 <div class="summary">

1418 <!-- Note: intentionally longer 80 columns -->

1419 <span>chrome.tabs.highlight</span>(<span class="null"><span>ob ject</span>

1420 <var><span>highlightInfo</span></var></span><span class="n ull"><span>, </span><span>function</span>

1421 <var><span>callback</span></var></span>)</div>

1422 <div class="description">

1423 <p>Highlights the given tabs.</p>

1424 <!-- PARAMETERS -->

1425 <h4>Parameters</h4>

1426 <dl>

1427 <div>

1428 <div>

1429 <dt>

1430 <var>highlightInfo</var>

1431 <em>

1432 <!-- TYPE -->

1433 <div style="display:inline">

1434 (

1435 <span id="typeTemplate">

1436 <span>

1437 <span>object</span>

1438 </span>

1439 </span>

1440 )

1441 </div>

1442 </em>

1443 </dt>

1444 <dd class="todo">

1445 Undocumented.

1446 </dd>

1447 <!-- OBJECT PROPERTIES -->

1448 <dd>

1449 <dl>

1450 <div>

1451 <div>

1452 <dt>

1453 <var>windowId</var>

1454 <em>

1455 <!-- TYPE -->

1456 <div style="display:inline">

1457 (

1458 <span class="optional">optional</span>

1459 <span id="typeTemplate">

1460 <span>

1461 <span>integer</span>

1462 </span>

1463 </span>

1464 )

1465 </div>

1466 </em>

1467 </dt>

1468 <dd>The window that contains the tabs.</dd>

1469 <!-- OBJECT PROPERTIES -->

1470 <!-- OBJECT METHODS -->

1471 <!-- OBJECT EVENT FIELDS -->

1472 <!-- FUNCTION PARAMETERS -->

1473 </div>

1474 </div><div>

1475 <div>

1476 <dt>

1477 <var>tabs</var>

1478 <em>

1479 <!-- TYPE -->

1480 <div style="display:inline">

1481 (

1482 <span id="typeTemplate">

1483 <span>

1484 <span>array of integer or integer</span>

1485 </span>

1486 </span>

1487 )

1488 </div>

1489 </em>

1490 </dt>

1491 <dd>One or more tab indices to highlight.</dd>

1492 <!-- OBJECT PROPERTIES -->

1493 <!-- OBJECT METHODS -->

1494 <!-- OBJECT EVENT FIELDS -->

1495 <!-- FUNCTION PARAMETERS -->

1496 </div>

1497 </div>

1498 </dl>

1499 </dd>

1500 <!-- OBJECT METHODS -->

1501 <!-- OBJECT EVENT FIELDS -->

1502 <!-- FUNCTION PARAMETERS -->

1503 </div>

1504 </div><div>

1505 <div>

1506 <dt>

1507 <var>callback</var>

1508 <em>

1509 <!-- TYPE -->

1510 <div style="display:inline">

1511 (

1512 <span id="typeTemplate">

1513 <span>

1514 <span>function</span>

1515 </span>

1516 </span>

1517 )

1518 </div>

1519 </em>

1520 </dt>

1521 <dd class="todo">

1522 Undocumented.

1523 </dd>

1524 <!-- OBJECT PROPERTIES -->

1525 <!-- OBJECT METHODS -->

1526 <!-- OBJECT EVENT FIELDS -->

1527 <!-- FUNCTION PARAMETERS -->

1528 </div>

1529 </div>

1530 </dl>

1531 <!-- RETURNS -->

1532 <dl>

1533 </dl>

1534 <!-- CALLBACK -->

1535 <div>

1536 <div>

1537 <h4>Callback function</h4>

1538 <p>

1539 The <em>callback</em> parameter should specify a function

1540 that looks like this:

1541 </p>

1542 <!-- Note: intentionally longer 80 columns -->

1543 <pre>function(<span>windows.Window window</span>) <span class= "subdued">{...}</span>;</pre>

1544 <dl>

1545 <div>

1546 <div>

1547 <dt>

1548 <var>window</var>

1549 <em>

1550 <!-- TYPE -->

1551 <div style="display:inline">

1552 (

1553 <span id="typeTemplate">

1554 <span>

1555 <a>windows.Window</a>

1556 </span>

1557 </span>

1558 )

1559 </div>

1560 </em>

1561 </dt>

1562 <dd>Contains details about the window whose tabs were highlighted.</dd >

1563 <!-- OBJECT PROPERTIES -->

1564 <!-- OBJECT METHODS -->

1565 <!-- OBJECT EVENT FIELDS -->

1566 <!-- FUNCTION PARAMETERS -->

1567 </div>

1568 </div>

1569 </dl>

1570 </div>

1571 </div>

1572 <!-- MIN_VERSION -->

1573 </div> <!-- /description -->

1574 </div><div class="apiItem">

1575 <a name="method-insertCSS"></a> <!-- method-anchor -->

1576 <h4>insertCSS</h4>

1577 <div class="summary">

1578 <!-- Note: intentionally longer 80 columns -->

1579 <span>chrome.tabs.insertCSS</span>(<span class="optional"><spa n>integer</span>

1580 <var><span>tabId</span></var></span><span class="null"><sp an>, </span><span>object</span>

1581 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>

1582 <var><span>callback</span></var></span>)</div>

1583 <div class="description">

1584 <p>Injects CSS into a page. For details, see the <a href="conten t_scripts.html#pi">programmatic injection</a> section of the content scripts doc .</p>

1585 <!-- PARAMETERS -->

1586 <h4>Parameters</h4>

1587 <dl>

1588 <div>

1589 <div>

1590 <dt>

1591 <var>tabId</var>

1592 <em>

1593 <!-- TYPE -->

1594 <div style="display:inline">

1595 (

1596 <span class="optional">optional</span>

1597 <span id="typeTemplate">

1598 <span>

1599 <span>integer</span>

1600 </span>

1601 </span>

1602 )

1603 </div>

1604 </em>

1605 </dt>

1606 <dd>The ID of the tab in which to insert the CSS; defaults to the acti ve tab of the current window.</dd>

1607 <!-- OBJECT PROPERTIES -->

1608 <!-- OBJECT METHODS -->

1609 <!-- OBJECT EVENT FIELDS -->

1610 <!-- FUNCTION PARAMETERS -->

1611 </div>

1612 </div><div>

1613 <div>

1614 <dt>

1615 <var>details</var>

1616 <em>

1617 <!-- TYPE -->

1618 <div style="display:inline">

1619 (

1620 <span id="typeTemplate">

1621 <span>

1622 <span>object</span>

1623 </span>

1624 </span>

1625 )

1626 </div>

1627 </em>

1628 </dt>

1629 <dd>Details of the CSS text to insert. Either the code or the file pro perty must be set, but both may not be set at the same time.</dd>

1630 <!-- OBJECT PROPERTIES -->

1631 <dd>

1632 <dl>

1633 <div>

1634 <div>

1635 <dt>

1636 <var>code</var>

1637 <em>

1638 <!-- TYPE -->

1639 <div style="display:inline">

1640 (

1641 <span class="optional">optional</span>

1642 <span id="typeTemplate">

1643 <span>

1644 <span>string</span>

1645 </span>

1646 </span>

1647 )

1648 </div>

1649 </em>

1650 </dt>

1651 <dd>CSS code to be injected.</dd>

1652 <!-- OBJECT PROPERTIES -->

1653 <!-- OBJECT METHODS -->

1654 <!-- OBJECT EVENT FIELDS -->

1655 <!-- FUNCTION PARAMETERS -->

1656 </div>

1657 </div><div>

1658 <div>

1659 <dt>

1660 <var>file</var>

1661 <em>

1662 <!-- TYPE -->

1663 <div style="display:inline">

1664 (

1665 <span class="optional">optional</span>

1666 <span id="typeTemplate">

1667 <span>

1668 <span>string</span>

1669 </span>

1670 </span>

1671 )

1672 </div>

1673 </em>

1674 </dt>

1675 <dd>CSS file to be injected.</dd>

1676 <!-- OBJECT PROPERTIES -->

1677 <!-- OBJECT METHODS -->

1678 <!-- OBJECT EVENT FIELDS -->

1679 <!-- FUNCTION PARAMETERS -->

1680 </div>

1681 </div><div>

1682 <div>

1683 <dt>

1684 <var>allFrames</var>

1685 <em>

1686 <!-- TYPE -->

1687 <div style="display:inline">

1688 (

1689 <span class="optional">optional</span>

1690 <span id="typeTemplate">

1691 <span>

1692 <span>boolean</span>

1693 </span>

1694 </span>

1695 )

1696 </div>

1697 </em>

1698 </dt>

1699 <dd>If allFrames is true, this function injects CSS text into all fram es of current page. By default, it's false and CSS is injected only into the top main frame.</dd>

1700 <!-- OBJECT PROPERTIES -->

1701 <!-- OBJECT METHODS -->

1702 <!-- OBJECT EVENT FIELDS -->

1703 <!-- FUNCTION PARAMETERS -->

1704 </div>

1705 </div><div>

1706 <div>

1707 <dt>

1708 <var>runAt</var>

1709 <em>

1710 <!-- TYPE -->

1711 <div style="display:inline">

1712 (

1713 <span class="optional">optional</span>

1714 <span class="enum">enumerated</span>

1715 <span id="typeTemplate">

1716 <span>

1717 <span>string</span>

1718 <span>["document_start", "document_end", "document_idle" ]</span>

1719 </span>

1720 </span>

1721 )

1722 </div>

1723 </em>

1724 </dt>

1725 <dd>The soonest that the CSS will be injected into the tab. Defaults t o "document_idle".</dd>

1726 <!-- OBJECT PROPERTIES -->

1727 <!-- OBJECT METHODS -->

1728 <!-- OBJECT EVENT FIELDS -->

1729 <!-- FUNCTION PARAMETERS -->

1730 </div>

1731 </div>

1732 </dl>

1733 </dd>

1734 <!-- OBJECT METHODS -->

1735 <!-- OBJECT EVENT FIELDS -->

1736 <!-- FUNCTION PARAMETERS -->

1737 </div>

1738 </div><div>

1739 <div>

1740 <dt>

1741 <var>callback</var>

1742 <em>

1743 <!-- TYPE -->

1744 <div style="display:inline">

1745 (

1746 <span class="optional">optional</span>

1747 <span id="typeTemplate">

1748 <span>

1749 <span>function</span>

1750 </span>

1751 </span>

1752 )

1753 </div>

1754 </em>

1755 </dt>

1756 <dd>Called when all the CSS has been inserted.</dd>

1757 <!-- OBJECT PROPERTIES -->

1758 <!-- OBJECT METHODS -->

1759 <!-- OBJECT EVENT FIELDS -->

1760 <!-- FUNCTION PARAMETERS -->

1761 </div>

1762 </div>

1763 </dl>

1764 <!-- RETURNS -->

1765 <dl>

1766 </dl>

1767 <!-- CALLBACK -->

1768 <div>

1769 <div>

1770 <h4>Callback function</h4>

1771 <p>

1772 If you specify the <em>callback</em> parameter, it should

1773 specify a function that looks like this:

1774 </p>

1775 <!-- Note: intentionally longer 80 columns -->

1776 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>

1777 <dl>

1778 </dl>

1779 </div>

1780 </div>

1781 <!-- MIN_VERSION -->

1782 </div> <!-- /description -->

1783 </div><div class="apiItem">

1784 <a name="method-move"></a> <!-- method-anchor -->

1785 <h4>move</h4>

1786 <div class="summary">

1787 <!-- Note: intentionally longer 80 columns -->

1788 <span>chrome.tabs.move</span>(<span class="null"><span>integer or array of integer</span>

1789 <var><span>tabIds</span></var></span><span class="null"><s pan>, </span><span>object</span>

1790 <var><span>moveProperties</span></var></span><span class=" optional"><span>, </span><span>function</span>

1791 <var><span>callback</span></var></span>)</div>

1792 <div class="description">

1793 <p>Moves one or more tabs to a new position within its window, o r to a new window. Note that tabs can only be moved to and from normal (window.t ype === "normal") windows.</p>

1794 <!-- PARAMETERS -->

1795 <h4>Parameters</h4>

1796 <dl>

1797 <div>

1798 <div>

1799 <dt>

1800 <var>tabIds</var>

1801 <em>

1802 <!-- TYPE -->

1803 <div style="display:inline">

1804 (

1805 <span id="typeTemplate">

1806 <span>

1807 <span>integer or array of integer</span>

1808 </span>

1809 </span>

1810 )

1811 </div>

1812 </em>

1813 </dt>

1814 <dd>The tab or list of tabs to move.</dd>

1815 <!-- OBJECT PROPERTIES -->

1816 <!-- OBJECT METHODS -->

1817 <!-- OBJECT EVENT FIELDS -->

1818 <!-- FUNCTION PARAMETERS -->

1819 </div>

1820 </div><div>

1821 <div>

1822 <dt>

1823 <var>moveProperties</var>

1824 <em>

1825 <!-- TYPE -->

1826 <div style="display:inline">

1827 (

1828 <span id="typeTemplate">

1829 <span>

1830 <span>object</span>

1831 </span>

1832 </span>

1833 )

1834 </div>

1835 </em>

1836 </dt>

1837 <dd class="todo">

1838 Undocumented.

1839 </dd>

1840 <!-- OBJECT PROPERTIES -->

1841 <dd>

1842 <dl>

1843 <div>

1844 <div>

1845 <dt>

1846 <var>windowId</var>

1847 <em>

1848 <!-- TYPE -->

1849 <div style="display:inline">

1850 (

1851 <span class="optional">optional</span>

1852 <span id="typeTemplate">

1853 <span>

1854 <span>integer</span>

1855 </span>

1856 </span>

1857 )

1858 </div>

1859 </em>

1860 </dt>

1861 <dd>Defaults to the window the tab is currently in.</dd>

1862 <!-- OBJECT PROPERTIES -->

1863 <!-- OBJECT METHODS -->

1864 <!-- OBJECT EVENT FIELDS -->

1865 <!-- FUNCTION PARAMETERS -->

1866 </div>

1867 </div><div>

1868 <div>

1869 <dt>

1870 <var>index</var>

1871 <em>

1872 <!-- TYPE -->

1873 <div style="display:inline">

1874 (

1875 <span id="typeTemplate">

1876 <span>

1877 <span>integer</span>

1878 </span>

1879 </span>

1880 )

1881 </div>

1882 </em>

1883 </dt>

1884 <dd>The position to move the window to. -1 will place the tab at the e nd of the window.</dd>

1885 <!-- OBJECT PROPERTIES -->

1886 <!-- OBJECT METHODS -->

1887 <!-- OBJECT EVENT FIELDS -->

1888 <!-- FUNCTION PARAMETERS -->

1889 </div>

1890 </div>

1891 </dl>

1892 </dd>

1893 <!-- OBJECT METHODS -->

1894 <!-- OBJECT EVENT FIELDS -->

1895 <!-- FUNCTION PARAMETERS -->

1896 </div>

1897 </div><div>

1898 <div>

1899 <dt>

1900 <var>callback</var>

1901 <em>

1902 <!-- TYPE -->

1903 <div style="display:inline">

1904 (

1905 <span class="optional">optional</span>

1906 <span id="typeTemplate">

1907 <span>

1908 <span>function</span>

1909 </span>

1910 </span>

1911 )

1912 </div>

1913 </em>

1914 </dt>

1915 <dd class="todo">

1916 Undocumented.

1917 </dd>

1918 <!-- OBJECT PROPERTIES -->

1919 <!-- OBJECT METHODS -->

1920 <!-- OBJECT EVENT FIELDS -->

1921 <!-- FUNCTION PARAMETERS -->

1922 </div>

1923 </div>

1924 </dl>

1925 <!-- RETURNS -->

1926 <dl>

1927 </dl>

1928 <!-- CALLBACK -->

1929 <div>

1930 <div>

1931 <h4>Callback function</h4>

1932 <p>

1933 If you specify the <em>callback</em> parameter, it should

1934 specify a function that looks like this:

1935 </p>

1936 <!-- Note: intentionally longer 80 columns -->

1937 <pre>function(<span>Tab or array of Tab tabs</span>) <span cla ss="subdued">{...}</span>;</pre>

1938 <dl>

1939 <div>

1940 <div>

1941 <dt>

1942 <var>tabs</var>

1943 <em>

1944 <!-- TYPE -->

1945 <div style="display:inline">

1946 (

1947 <span id="typeTemplate">

1948 <span>

1949 <span>Tab or array of Tab</span>

1950 </span>

1951 </span>

1952 )

1953 </div>

1954 </em>

1955 </dt>

1956 <dd>Details about the moved tabs.</dd>

1957 <!-- OBJECT PROPERTIES -->

1958 <!-- OBJECT METHODS -->

1959 <!-- OBJECT EVENT FIELDS -->

1960 <!-- FUNCTION PARAMETERS -->

1961 </div>

1962 </div>

1963 </dl>

1964 </div>

1965 </div>

1966 <!-- MIN_VERSION -->

1967 </div> <!-- /description -->

1968 </div><div class="apiItem">

1969 <a name="method-query"></a> <!-- method-anchor -->

1970 <h4>query</h4>

1971 <div class="summary">

1972 <!-- Note: intentionally longer 80 columns -->

1973 <span>chrome.tabs.query</span>(<span class="null"><span>object </span>

1974 <var><span>queryInfo</span></var></span><span class="null" ><span>, </span><span>function</span>

1975 <var><span>callback</span></var></span>)</div>

1976 <div class="description">

1977 <p>Gets all tabs that have the specified properties, or all tabs if no properties are specified.</p>

1978 <!-- PARAMETERS -->

1979 <h4>Parameters</h4>

1980 <dl>

1981 <div>

1982 <div>

1983 <dt>

1984 <var>queryInfo</var>

1985 <em>

1986 <!-- TYPE -->

1987 <div style="display:inline">

1988 (

1989 <span id="typeTemplate">

1990 <span>

1991 <span>object</span>

1992 </span>

1993 </span>

1994 )

1995 </div>

1996 </em>

1997 </dt>

1998 <dd class="todo">

1999 Undocumented.

2000 </dd>

2001 <!-- OBJECT PROPERTIES -->

2002 <dd>

2003 <dl>

2004 <div>

2005 <div>

2006 <dt>

2007 <var>active</var>

2008 <em>

2009 <!-- TYPE -->

2010 <div style="display:inline">

2011 (

2012 <span class="optional">optional</span>

2013 <span id="typeTemplate">

2014 <span>

2015 <span>boolean</span>

2016 </span>

2017 </span>

2018 )

2019 </div>

2020 </em>

2021 </dt>

2022 <dd>Whether the tabs are active in their windows.</dd>

2023 <!-- OBJECT PROPERTIES -->

2024 <!-- OBJECT METHODS -->

2025 <!-- OBJECT EVENT FIELDS -->

2026 <!-- FUNCTION PARAMETERS -->

2027 </div>

2028 </div><div>

2029 <div>

2030 <dt>

2031 <var>pinned</var>

2032 <em>

2033 <!-- TYPE -->

2034 <div style="display:inline">

2035 (

2036 <span class="optional">optional</span>

2037 <span id="typeTemplate">

2038 <span>

2039 <span>boolean</span>

2040 </span>

2041 </span>

2042 )

2043 </div>

2044 </em>

2045 </dt>

2046 <dd>Whether the tabs are pinned.</dd>

2047 <!-- OBJECT PROPERTIES -->

2048 <!-- OBJECT METHODS -->

2049 <!-- OBJECT EVENT FIELDS -->

2050 <!-- FUNCTION PARAMETERS -->

2051 </div>

2052 </div><div>

2053 <div>

2054 <dt>

2055 <var>highlighted</var>

2056 <em>

2057 <!-- TYPE -->

2058 <div style="display:inline">

2059 (

2060 <span class="optional">optional</span>

2061 <span id="typeTemplate">

2062 <span>

2063 <span>boolean</span>

2064 </span>

2065 </span>

2066 )

2067 </div>

2068 </em>

2069 </dt>

2070 <dd>Whether the tabs are highlighted.</dd>

2071 <!-- OBJECT PROPERTIES -->

2072 <!-- OBJECT METHODS -->

2073 <!-- OBJECT EVENT FIELDS -->

2074 <!-- FUNCTION PARAMETERS -->

2075 </div>

2076 </div><div>

2077 <div>

2078 <dt>

2079 <var>currentWindow</var>

2080 <em>

2081 <!-- TYPE -->

2082 <div style="display:inline">

2083 (

2084 <span class="optional">optional</span>

2085 <span id="typeTemplate">

2086 <span>

2087 <span>boolean</span>

2088 </span>

2089 </span>

2090 )

2091 </div>

2092 </em>

2093 </dt>

2094 <dd>Whether the tabs are in the <a href="windows.html#current-window"> current window</a>.</dd>

2095 <!-- OBJECT PROPERTIES -->

2096 <!-- OBJECT METHODS -->

2097 <!-- OBJECT EVENT FIELDS -->

2098 <!-- FUNCTION PARAMETERS -->

2099 </div>

2100 </div><div>

2101 <div>

2102 <dt>

2103 <var>lastFocusedWindow</var>

2104 <em>

2105 <!-- TYPE -->

2106 <div style="display:inline">

2107 (

2108 <span class="optional">optional</span>

2109 <span id="typeTemplate">

2110 <span>

2111 <span>boolean</span>

2112 </span>

2113 </span>

2114 )

2115 </div>

2116 </em>

2117 </dt>

2118 <dd>Whether the tabs are in the last focused window.</dd>

2119 <!-- OBJECT PROPERTIES -->

2120 <!-- OBJECT METHODS -->

2121 <!-- OBJECT EVENT FIELDS -->

2122 <!-- FUNCTION PARAMETERS -->

2123 </div>

2124 </div><div>

2125 <div>

2126 <dt>

2127 <var>status</var>

2128 <em>

2129 <!-- TYPE -->

2130 <div style="display:inline">

2131 (

2132 <span class="optional">optional</span>

2133 <span class="enum">enumerated</span>

2134 <span id="typeTemplate">

2135 <span>

2136 <span>string</span>

2137 <span>["loading", "complete"]</span>

2138 </span>

2139 </span>

2140 )

2141 </div>

2142 </em>

2143 </dt>

2144 <dd>Whether the tabs have completed loading.</dd>

2145 <!-- OBJECT PROPERTIES -->

2146 <!-- OBJECT METHODS -->

2147 <!-- OBJECT EVENT FIELDS -->

2148 <!-- FUNCTION PARAMETERS -->

2149 </div>

2150 </div><div>

2151 <div>

2152 <dt>

2153 <var>title</var>

2154 <em>

2155 <!-- TYPE -->

2156 <div style="display:inline">

2157 (

2158 <span class="optional">optional</span>

2159 <span id="typeTemplate">

2160 <span>

2161 <span>string</span>

2162 </span>

2163 </span>

2164 )

2165 </div>

2166 </em>

2167 </dt>

2168 <dd>Match page titles against a pattern.</dd>

2169 <!-- OBJECT PROPERTIES -->

2170 <!-- OBJECT METHODS -->

2171 <!-- OBJECT EVENT FIELDS -->

2172 <!-- FUNCTION PARAMETERS -->

2173 </div>

2174 </div><div>

2175 <div>

2176 <dt>

2177 <var>url</var>

2178 <em>

2179 <!-- TYPE -->

2180 <div style="display:inline">

2181 (

2182 <span class="optional">optional</span>

2183 <span id="typeTemplate">

2184 <span>

2185 <span>string</span>

2186 </span>

2187 </span>

2188 )

2189 </div>

2190 </em>

2191 </dt>

2192 <dd>Match tabs against a URL pattern.</dd>

2193 <!-- OBJECT PROPERTIES -->

2194 <!-- OBJECT METHODS -->

2195 <!-- OBJECT EVENT FIELDS -->

2196 <!-- FUNCTION PARAMETERS -->

2197 </div>

2198 </div><div>

2199 <div>

2200 <dt>

2201 <var>windowId</var>

2202 <em>

2203 <!-- TYPE -->

2204 <div style="display:inline">

2205 (

2206 <span class="optional">optional</span>

2207 <span id="typeTemplate">

2208 <span>

2209 <span>integer</span>

2210 </span>

2211 </span>

2212 )

2213 </div>

2214 </em>

2215 </dt>

2216 <dd>The ID of the parent window, or <a href="windows.html#property-WIN DOW_ID_CURRENT">chrome.windows.WINDOW_ID_CURRENT</a> for the <a href="windows.ht ml#current-window">current window</a>.</dd>

2217 <!-- OBJECT PROPERTIES -->

2218 <!-- OBJECT METHODS -->

2219 <!-- OBJECT EVENT FIELDS -->

2220 <!-- FUNCTION PARAMETERS -->

2221 </div>

2222 </div><div>

2223 <div>

2224 <dt>

2225 <var>windowType</var>

2226 <em>

2227 <!-- TYPE -->

2228 <div style="display:inline">

2229 (

2230 <span class="optional">optional</span>

2231 <span class="enum">enumerated</span>

2232 <span id="typeTemplate">

2233 <span>

2234 <span>string</span>

2235 <span>["normal", "popup", "panel", "app"]</span>

2236 </span>

2237 </span>

2238 )

2239 </div>

2240 </em>

2241 </dt>

2242 <dd>The type of window the tabs are in.</dd>

2243 <!-- OBJECT PROPERTIES -->

2244 <!-- OBJECT METHODS -->

2245 <!-- OBJECT EVENT FIELDS -->

2246 <!-- FUNCTION PARAMETERS -->

2247 </div>

2248 </div><div>

2249 <div>

2250 <dt>

2251 <var>index</var>

2252 <em>

2253 <!-- TYPE -->

2254 <div style="display:inline">

2255 (

2256 <span class="optional">optional</span>

2257 <span id="typeTemplate">

2258 <span>

2259 <span>integer</span>

2260 </span>

2261 </span>

2262 )

2263 </div>

2264 </em>

2265 </dt>

2266 <dd>The position of the tabs within their windows.</dd>

2267 <!-- OBJECT PROPERTIES -->

2268 <!-- OBJECT METHODS -->

2269 <!-- OBJECT EVENT FIELDS -->

2270 <!-- FUNCTION PARAMETERS -->

2271 </div>

2272 </div>

2273 </dl>

2274 </dd>

2275 <!-- OBJECT METHODS -->

2276 <!-- OBJECT EVENT FIELDS -->

2277 <!-- FUNCTION PARAMETERS -->

2278 </div>

2279 </div><div>

2280 <div>

2281 <dt>

2282 <var>callback</var>

2283 <em>

2284 <!-- TYPE -->

2285 <div style="display:inline">

2286 (

2287 <span id="typeTemplate">

2288 <span>

2289 <span>function</span>

2290 </span>

2291 </span>

2292 )

2293 </div>

2294 </em>

2295 </dt>

2296 <dd class="todo">

2297 Undocumented.

2298 </dd>

2299 <!-- OBJECT PROPERTIES -->

2300 <!-- OBJECT METHODS -->

2301 <!-- OBJECT EVENT FIELDS -->

2302 <!-- FUNCTION PARAMETERS -->

2303 </div>

2304 </div>

2305 </dl>

2306 <!-- RETURNS -->

2307 <dl>

2308 </dl>

2309 <!-- CALLBACK -->

2310 <div>

2311 <div>

2312 <h4>Callback function</h4>

2313 <p>

2314 The <em>callback</em> parameter should specify a function

2315 that looks like this:

2316 </p>

2317 <!-- Note: intentionally longer 80 columns -->

2318 <pre>function(<span>array of Tab result</span>) <span class="s ubdued">{...}</span>;</pre>

2319 <dl>

2320 <div>

2321 <div>

2322 <dt>

2323 <var>result</var>

2324 <em>

2325 <!-- TYPE -->

2326 <div style="display:inline">

2327 (

2328 <span id="typeTemplate">

2329 <span>

2330 <span>

2331 array of <span><span>

2332 <span>

2333 <a href="tabs.html#type-Tab">Tab</a>

2334 </span>

2335 </span></span>

2336 </span>

2337 </span>

2338 </span>

2339 )

2340 </div>

2341 </em>

2342 </dt>

2343 <dd class="todo">

2344 Undocumented.

2345 </dd>

2346 <!-- OBJECT PROPERTIES -->

2347 <!-- OBJECT METHODS -->

2348 <!-- OBJECT EVENT FIELDS -->

2349 <!-- FUNCTION PARAMETERS -->

2350 </div>

2351 </div>

2352 </dl>

2353 </div>

2354 </div>

2355 <!-- MIN_VERSION -->

2356 </div> <!-- /description -->

2357 </div><div class="apiItem">

2358 <a name="method-reload"></a> <!-- method-anchor -->

2359 <h4>reload</h4>

2360 <div class="summary">

2361 <!-- Note: intentionally longer 80 columns -->

2362 <span>chrome.tabs.reload</span>(<span class="optional"><span>i nteger</span>

2363 <var><span>tabId</span></var></span><span class="optional" ><span>, </span><span>object</span>

2364 <var><span>reloadProperties</span></var></span><span class ="optional"><span>, </span><span>function</span>

2365 <var><span>callback</span></var></span>)</div>

2366 <div class="description">

2367 <p>Reload a tab.</p>

2368 <!-- PARAMETERS -->

2369 <h4>Parameters</h4>

2370 <dl>

2371 <div>

2372 <div>

2373 <dt>

2374 <var>tabId</var>

2375 <em>

2376 <!-- TYPE -->

2377 <div style="display:inline">

2378 (

2379 <span class="optional">optional</span>

2380 <span id="typeTemplate">

2381 <span>

2382 <span>integer</span>

2383 </span>

2384 </span>

2385 )

2386 </div>

2387 </em>

2388 </dt>

2389 <dd>The ID of the tab to reload; defaults to the selected tab of the c urrent window.</dd>

2390 <!-- OBJECT PROPERTIES -->

2391 <!-- OBJECT METHODS -->

2392 <!-- OBJECT EVENT FIELDS -->

2393 <!-- FUNCTION PARAMETERS -->

2394 </div>

2395 </div><div>

2396 <div>

2397 <dt>

2398 <var>reloadProperties</var>

2399 <em>

2400 <!-- TYPE -->

2401 <div style="display:inline">

2402 (

2403 <span class="optional">optional</span>

2404 <span id="typeTemplate">

2405 <span>

2406 <span>object</span>

2407 </span>

2408 </span>

2409 )

2410 </div>

2411 </em>

2412 </dt>

2413 <dd class="todo">

2414 Undocumented.

2415 </dd>

2416 <!-- OBJECT PROPERTIES -->

2417 <dd>

2418 <dl>

2419 <div>

2420 <div>

2421 <dt>

2422 <var>bypassCache</var>

2423 <em>

2424 <!-- TYPE -->

2425 <div style="display:inline">

2426 (

2427 <span class="optional">optional</span>

2428 <span id="typeTemplate">

2429 <span>

2430 <span>boolean</span>

2431 </span>

2432 </span>

2433 )

2434 </div>

2435 </em>

2436 </dt>

2437 <dd>Whether using any local cache. Default is false.</dd>

2438 <!-- OBJECT PROPERTIES -->

2439 <!-- OBJECT METHODS -->

2440 <!-- OBJECT EVENT FIELDS -->

2441 <!-- FUNCTION PARAMETERS -->

2442 </div>

2443 </div>

2444 </dl>

2445 </dd>

2446 <!-- OBJECT METHODS -->

2447 <!-- OBJECT EVENT FIELDS -->

2448 <!-- FUNCTION PARAMETERS -->

2449 </div>

2450 </div><div>

2451 <div>

2452 <dt>

2453 <var>callback</var>

2454 <em>

2455 <!-- TYPE -->

2456 <div style="display:inline">

2457 (

2458 <span class="optional">optional</span>

2459 <span id="typeTemplate">

2460 <span>

2461 <span>function</span>

2462 </span>

2463 </span>

2464 )

2465 </div>

2466 </em>

2467 </dt>

2468 <dd class="todo">

2469 Undocumented.

2470 </dd>

2471 <!-- OBJECT PROPERTIES -->

2472 <!-- OBJECT METHODS -->

2473 <!-- OBJECT EVENT FIELDS -->

2474 <!-- FUNCTION PARAMETERS -->

2475 </div>

2476 </div>

2477 </dl>

2478 <!-- RETURNS -->

2479 <dl>

2480 </dl>

2481 <!-- CALLBACK -->

2482 <div>

2483 <div>

2484 <h4>Callback function</h4>

2485 <p>

2486 If you specify the <em>callback</em> parameter, it should

2487 specify a function that looks like this:

2488 </p>

2489 <!-- Note: intentionally longer 80 columns -->

2490 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>

2491 <dl>

2492 </dl>

2493 </div>

2494 </div>

2495 <!-- MIN_VERSION -->

2496 </div> <!-- /description -->

2497 </div><div class="apiItem">

2498 <a name="method-remove"></a> <!-- method-anchor -->

2499 <h4>remove</h4>

2500 <div class="summary">

2501 <!-- Note: intentionally longer 80 columns -->

2502 <span>chrome.tabs.remove</span>(<span class="null"><span>integ er or array of integer</span>

2503 <var><span>tabIds</span></var></span><span class="optional "><span>, </span><span>function</span>

2504 <var><span>callback</span></var></span>)</div>

2505 <div class="description">

2506 <p>Closes one or more tabs. Note: This function can be used with out requesting the 'tabs' permission in the manifest.</p>

2507 <!-- PARAMETERS -->

2508 <h4>Parameters</h4>

2509 <dl>

2510 <div>

2511 <div>

2512 <dt>

2513 <var>tabIds</var>

2514 <em>

2515 <!-- TYPE -->

2516 <div style="display:inline">

2517 (

2518 <span id="typeTemplate">

2519 <span>

2520 <span>integer or array of integer</span>

2521 </span>

2522 </span>

2523 )

2524 </div>

2525 </em>

2526 </dt>

2527 <dd>The tab or list of tabs to close.</dd>

2528 <!-- OBJECT PROPERTIES -->

2529 <!-- OBJECT METHODS -->

2530 <!-- OBJECT EVENT FIELDS -->

2531 <!-- FUNCTION PARAMETERS -->

2532 </div>

2533 </div><div>

2534 <div>

2535 <dt>

2536 <var>callback</var>

2537 <em>

2538 <!-- TYPE -->

2539 <div style="display:inline">

2540 (

2541 <span class="optional">optional</span>

2542 <span id="typeTemplate">

2543 <span>

2544 <span>function</span>

2545 </span>

2546 </span>

2547 )

2548 </div>

2549 </em>

2550 </dt>

2551 <dd class="todo">

2552 Undocumented.

2553 </dd>

2554 <!-- OBJECT PROPERTIES -->

2555 <!-- OBJECT METHODS -->

2556 <!-- OBJECT EVENT FIELDS -->

2557 <!-- FUNCTION PARAMETERS -->

2558 </div>

2559 </div>

2560 </dl>

2561 <!-- RETURNS -->

2562 <dl>

2563 </dl>

2564 <!-- CALLBACK -->

2565 <div>

2566 <div>

2567 <h4>Callback function</h4>

2568 <p>

2569 If you specify the <em>callback</em> parameter, it should

2570 specify a function that looks like this:

2571 </p>

2572 <!-- Note: intentionally longer 80 columns -->

2573 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>

2574 <dl>

2575 </dl>

2576 </div>

2577 </div>

2578 <!-- MIN_VERSION -->

2579 </div> <!-- /description -->

2580 </div><div class="apiItem">

2581 <a name="method-sendMessage"></a> <!-- method-anchor -->

2582 <h4>sendMessage</h4>

2583 <div class="summary">

2584 <!-- Note: intentionally longer 80 columns -->

2585 <span>chrome.tabs.sendMessage</span>(<span class="null"><span> integer</span>

2586 <var><span>tabId</span></var></span><span class="null"><sp an>, </span><span>any</span>

2587 <var><span>message</span></var></span><span class="optiona l"><span>, </span><span>function</span>

2588 <var><span>responseCallback</span></var></span>)</div>

2589 <div class="description">

2590 <p>Sends a single message to the content script(s) in the specif ied tab, with an optional callback to run when a response is sent back. The <a href="extension.html#event-onMessage">chrome.extension.onMessage</a> event is fi red in each content script running in the specified tab for the current extensio n.</p>

2591 <!-- PARAMETERS -->

2592 <h4>Parameters</h4>

2593 <dl>

2594 <div>

2595 <div>

2596 <dt>

2597 <var>tabId</var>

2598 <em>

2599 <!-- TYPE -->

2600 <div style="display:inline">

2601 (

2602 <span id="typeTemplate">

2603 <span>

2604 <span>integer</span>

2605 </span>

2606 </span>

2607 )

2608 </div>

2609 </em>

2610 </dt>

2611 <dd class="todo">

2612 Undocumented.

2613 </dd>

2614 <!-- OBJECT PROPERTIES -->

2615 <!-- OBJECT METHODS -->

2616 <!-- OBJECT EVENT FIELDS -->

2617 <!-- FUNCTION PARAMETERS -->

2618 </div>

2619 </div><div>

2620 <div>

2621 <dt>

2622 <var>message</var>

2623 <em>

2624 <!-- TYPE -->

2625 <div style="display:inline">

2626 (

2627 <span id="typeTemplate">

2628 <span>

2629 <span>any</span>

2630 </span>

2631 </span>

2632 )

2633 </div>

2634 </em>

2635 </dt>

2636 <dd class="todo">

2637 Undocumented.

2638 </dd>

2639 <!-- OBJECT PROPERTIES -->

2640 <!-- OBJECT METHODS -->

2641 <!-- OBJECT EVENT FIELDS -->

2642 <!-- FUNCTION PARAMETERS -->

2643 </div>

2644 </div><div>

2645 <div>

2646 <dt>

2647 <var>responseCallback</var>

2648 <em>

2649 <!-- TYPE -->

2650 <div style="display:inline">

2651 (

2652 <span class="optional">optional</span>

2653 <span id="typeTemplate">

2654 <span>

2655 <span>function</span>

2656 </span>

2657 </span>

2658 )

2659 </div>

2660 </em>

2661 </dt>

2662 <dd class="todo">

2663 Undocumented.

2664 </dd>

2665 <!-- OBJECT PROPERTIES -->

2666 <!-- OBJECT METHODS -->

2667 <!-- OBJECT EVENT FIELDS -->

2668 <!-- FUNCTION PARAMETERS -->

2669 <dd>

2670 <div>

2671 <h5>Parameters</h5>

2672 <dl>

2673 <div>

2674 <div>

2675 <dt>

2676 <var>response</var>

2677 <em>

2678 <!-- TYPE -->

2679 <div style="display:inline">

2680 (

2681 <span id="typeTemplate">

2682 <span>

2683 <span>any</span>

2684 </span>

2685 </span>

2686 )

2687 </div>

2688 </em>

2689 </dt>

2690 <dd>The JSON response object sent by the handler of the message. 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.extens ion.lastError</a> will be set to the error message.</dd>

2691 <!-- OBJECT PROPERTIES -->

2692 <!-- OBJECT METHODS -->

2693 <!-- OBJECT EVENT FIELDS -->

2694 <!-- FUNCTION PARAMETERS -->

2695 </div>

2696 </div>

2697 </dl>

2698 </div>

2699 </dd>

2700 </div>

2701 </div>

2702 </dl>

2703 <!-- RETURNS -->

2704 <dl>

2705 </dl>

2706 <!-- CALLBACK -->

2707 <div>

2708 <div>

2709 <h4>Callback function</h4>

2710 <p>

2711 If you specify the <em>callback</em> parameter, it should

2712 specify a function that looks like this:

2713 </p>

2714 <!-- Note: intentionally longer 80 columns -->

2715 <pre>function(<span>any response</span>) <span class="subdued" >{...}</span>;</pre>

2716 <dl>

2717 <div>

2718 <div>

2719 <dt>

2720 <var>response</var>

2721 <em>

2722 <!-- TYPE -->

2723 <div style="display:inline">

2724 (

2725 <span id="typeTemplate">

2726 <span>

2727 <span>any</span>

2728 </span>

2729 </span>

2730 )

2731 </div>

2732 </em>

2733 </dt>

2734 <dd>The JSON response object sent by the handler of the message. 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.extens ion.lastError</a> will be set to the error message.</dd>

2735 <!-- OBJECT PROPERTIES -->

2736 <!-- OBJECT METHODS -->

2737 <!-- OBJECT EVENT FIELDS -->

2738 <!-- FUNCTION PARAMETERS -->

2739 </div>

2740 </div>

2741 </dl>

2742 </div>

2743 </div>

2744 <!-- MIN_VERSION -->

2745 </div> <!-- /description -->

2746 </div><div class="apiItem">

2747 <a name="method-update"></a> <!-- method-anchor -->

2748 <h4>update</h4>

2749 <div class="summary">

2750 <!-- Note: intentionally longer 80 columns -->

2751 <span>chrome.tabs.update</span>(<span class="optional"><span>i nteger</span>

2752 <var><span>tabId</span></var></span><span class="null"><sp an>, </span><span>object</span>

2753 <var><span>updateProperties</span></var></span><span class ="optional"><span>, </span><span>function</span>

2754 <var><span>callback</span></var></span>)</div>

2755 <div class="description">

2756 <p>Modifies the properties of a tab. Properties that are not spe cified in <var>updateProperties</var> are not modified. Note: This function can be used without requesting the 'tabs' permission in the manifest.</p>

2757 <!-- PARAMETERS -->

2758 <h4>Parameters</h4>

2759 <dl>

2760 <div>

2761 <div>

2762 <dt>

2763 <var>tabId</var>

2764 <em>

2765 <!-- TYPE -->

2766 <div style="display:inline">

2767 (

2768 <span class="optional">optional</span>

2769 <span id="typeTemplate">

2770 <span>

2771 <span>integer</span>

2772 </span>

2773 </span>

2774 )

2775 </div>

2776 </em>

2777 </dt>

2778 <dd>Defaults to the selected tab of the <a href="windows.html#current- window">current window</a>.</dd>

2779 <!-- OBJECT PROPERTIES -->

2780 <!-- OBJECT METHODS -->

2781 <!-- OBJECT EVENT FIELDS -->

2782 <!-- FUNCTION PARAMETERS -->

2783 </div>

2784 </div><div>

2785 <div>

2786 <dt>

2787 <var>updateProperties</var>

2788 <em>

2789 <!-- TYPE -->

2790 <div style="display:inline">

2791 (

2792 <span id="typeTemplate">

2793 <span>

2794 <span>object</span>

2795 </span>

2796 </span>

2797 )

2798 </div>

2799 </em>

2800 </dt>

2801 <dd class="todo">

2802 Undocumented.

2803 </dd>

2804 <!-- OBJECT PROPERTIES -->

2805 <dd>

2806 <dl>

2807 <div>

2808 <div>

2809 <dt>

2810 <var>url</var>

2811 <em>

2812 <!-- TYPE -->

2813 <div style="display:inline">

2814 (

2815 <span class="optional">optional</span>

2816 <span id="typeTemplate">

2817 <span>

2818 <span>string</span>

2819 </span>

2820 </span>

2821 )

2822 </div>

2823 </em>

2824 </dt>

2825 <dd>A URL to navigate the tab to.</dd>

2826 <!-- OBJECT PROPERTIES -->

2827 <!-- OBJECT METHODS -->

2828 <!-- OBJECT EVENT FIELDS -->

2829 <!-- FUNCTION PARAMETERS -->

2830 </div>

2831 </div><div>

2832 <div>

2833 <dt>

2834 <var>active</var>

2835 <em>

2836 <!-- TYPE -->

2837 <div style="display:inline">

2838 (

2839 <span class="optional">optional</span>

2840 <span id="typeTemplate">

2841 <span>

2842 <span>boolean</span>

2843 </span>

2844 </span>

2845 )

2846 </div>

2847 </em>

2848 </dt>

2849 <dd>Whether the tab should be active.</dd>

2850 <!-- OBJECT PROPERTIES -->

2851 <!-- OBJECT METHODS -->

2852 <!-- OBJECT EVENT FIELDS -->

2853 <!-- FUNCTION PARAMETERS -->

2854 </div>

2855 </div><div>

2856 <div>

2857 <dt>

2858 <var>highlighted</var>

2859 <em>

2860 <!-- TYPE -->

2861 <div style="display:inline">

2862 (

2863 <span class="optional">optional</span>

2864 <span id="typeTemplate">

2865 <span>

2866 <span>boolean</span>

2867 </span>

2868 </span>

2869 )

2870 </div>

2871 </em>

2872 </dt>

2873 <dd>Adds or removes the tab from the current selection.</dd>

2874 <!-- OBJECT PROPERTIES -->

2875 <!-- OBJECT METHODS -->

2876 <!-- OBJECT EVENT FIELDS -->

2877 <!-- FUNCTION PARAMETERS -->

2878 </div>

2879 </div><div>

2880 <div>

2881 <dt>

2882 <var>pinned</var>

2883 <em>

2884 <!-- TYPE -->

2885 <div style="display:inline">

2886 (

2887 <span class="optional">optional</span>

2888 <span id="typeTemplate">

2889 <span>

2890 <span>boolean</span>

2891 </span>

2892 </span>

2893 )

2894 </div>

2895 </em>

2896 </dt>

2897 <dd>Whether the tab should be pinned.</dd>

2898 <!-- OBJECT PROPERTIES -->

2899 <!-- OBJECT METHODS -->

2900 <!-- OBJECT EVENT FIELDS -->

2901 <!-- FUNCTION PARAMETERS -->

2902 </div>

2903 </div><div>

2904 <div>

2905 <dt>

2906 <var>openerTabId</var>

2907 <em>

2908 <!-- TYPE -->

2909 <div style="display:inline">

2910 (

2911 <span class="optional">optional</span>

2912 <span id="typeTemplate">

2913 <span>

2914 <span>integer</span>

2915 </span>

2916 </span>

2917 )

2918 </div>

2919 </em>

2920 </dt>

2921 <dd>The ID of the tab that opened this tab. If specified, the opener t ab must be in the same window as this tab.</dd>

2922 <!-- OBJECT PROPERTIES -->

2923 <!-- OBJECT METHODS -->

2924 <!-- OBJECT EVENT FIELDS -->

2925 <!-- FUNCTION PARAMETERS -->

2926 </div>

2927 </div>

2928 </dl>

2929 </dd>

2930 <!-- OBJECT METHODS -->

2931 <!-- OBJECT EVENT FIELDS -->

2932 <!-- FUNCTION PARAMETERS -->

2933 </div>

2934 </div><div>

2935 <div>

2936 <dt>

2937 <var>callback</var>

2938 <em>

2939 <!-- TYPE -->

2940 <div style="display:inline">

2941 (

2942 <span class="optional">optional</span>

2943 <span id="typeTemplate">

2944 <span>

2945 <span>function</span>

2946 </span>

2947 </span>

2948 )

2949 </div>

2950 </em>

2951 </dt>

2952 <dd class="todo">

2953 Undocumented.

2954 </dd>

2955 <!-- OBJECT PROPERTIES -->

2956 <!-- OBJECT METHODS -->

2957 <!-- OBJECT EVENT FIELDS -->

2958 <!-- FUNCTION PARAMETERS -->

2959 </div>

2960 </div>

2961 </dl>

2962 <!-- RETURNS -->

2963 <dl>

2964 </dl>

2965 <!-- CALLBACK -->

2966 <div>

2967 <div>

2968 <h4>Callback function</h4>

2969 <p>

2970 If you specify the <em>callback</em> parameter, it should

2971 specify a function that looks like this:

2972 </p>

2973 <!-- Note: intentionally longer 80 columns -->

2974 <pre>function(<span>Tab tab</span>) <span class="subdued">{... }</span>;</pre>

2975 <dl>

2976 <div>

2977 <div>

2978 <dt>

2979 <var>tab</var>

2980 <em>

2981 <!-- TYPE -->

2982 <div style="display:inline">

2983 (

2984 <span class="optional">optional</span>

2985 <span id="typeTemplate">

2986 <span>

2987 <a href="tabs.html#type-Tab">Tab</a>

2988 </span>

2989 </span>

2990 )

2991 </div>

2992 </em>

2993 </dt>

2994 <dd>Details about the updated tab, or <code>null</code> if the 'tabs' permission has not been requested.</dd>

2995 <!-- OBJECT PROPERTIES -->

2996 <!-- OBJECT METHODS -->

2997 <!-- OBJECT EVENT FIELDS -->

2998 <!-- FUNCTION PARAMETERS -->

2999 </div>

3000 </div>

3001 </dl>

3002 </div>

3003 </div>

3004 <!-- MIN_VERSION -->

3005 </div> <!-- /description -->

3006 </div> <!-- /apiItem -->

3007 </div> <!-- /apiGroup -->

3008 <!-- EVENTS -->

3009 <div id="eventsTemplate" class="apiGroup">

3010 <a name="global-events"></a>

3011 <h3>Events</h3>

3012 <!-- iterates over all events -->

3013 <div class="apiItem">

3014 <a name="event-onActivated"></a>

3015 <h4>onActivated</h4>

3016 <div class="summary">

3017 <!-- Note: intentionally longer 80 columns -->

3018 <span class="subdued">chrome.tabs.</span><span>onActivated</span ><span class="subdued">.addListener</span>(function(<span>object activeInfo</spa n>) <span class="subdued">{...}</span><span></span>);

3019 </div>

3020 <div class="description">

3021 <p>Fires when the active tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to onU pdated events to be notified when a URL is set.</p>

3022 <!-- LISTENER PARAMETERS -->

3023 <div>

3024 <h4>Listener parameters</h4>

3025 <dl>

3026 <div>

3027 <div>

3028 <dt>

3029 <var>activeInfo</var>

3030 <em>

3031 <!-- TYPE -->

3032 <div style="display:inline">

3033 (

3034 <span id="typeTemplate">

3035 <span>

3036 <span>object</span>

3037 </span>

3038 </span>

3039 )

3040 </div>

3041 </em>

3042 </dt>

3043 <dd class="todo">

3044 Undocumented.

3045 </dd>

3046 <!-- OBJECT PROPERTIES -->

3047 <dd>

3048 <dl>

3049 <div>

3050 <div>

3051 <dt>

3052 <var>tabId</var>

3053 <em>

3054 <!-- TYPE -->

3055 <div style="display:inline">

3056 (

3057 <span id="typeTemplate">

3058 <span>

3059 <span>integer</span>

3060 </span>

3061 </span>

3062 )

3063 </div>

3064 </em>

3065 </dt>

3066 <dd>The ID of the tab that has become active.</dd>

3067 <!-- OBJECT PROPERTIES -->

3068 <!-- OBJECT METHODS -->

3069 <!-- OBJECT EVENT FIELDS -->

3070 <!-- FUNCTION PARAMETERS -->

3071 </div>

3072 </div><div>

3073 <div>

3074 <dt>

3075 <var>windowId</var>

3076 <em>

3077 <!-- TYPE -->

3078 <div style="display:inline">

3079 (

3080 <span id="typeTemplate">

3081 <span>

3082 <span>integer</span>

3083 </span>

3084 </span>

3085 )

3086 </div>

3087 </em>

3088 </dt>

3089 <dd>The ID of the window the active tab changed inside of.</dd>

3090 <!-- OBJECT PROPERTIES -->

3091 <!-- OBJECT METHODS -->

3092 <!-- OBJECT EVENT FIELDS -->

3093 <!-- FUNCTION PARAMETERS -->

3094 </div>

3095 </div>

3096 </dl>

3097 </dd>

3098 <!-- OBJECT METHODS -->

3099 <!-- OBJECT EVENT FIELDS -->

3100 <!-- FUNCTION PARAMETERS -->

3101 </div>

3102 </div>

3103 </dl>

3104 </div>

3105 <!-- EXTRA PARAMETERS -->

3106 <!-- LISTENER RETURN VALUE -->

3107 <dl>

3108 </dl>

3109 </div> <!-- /description -->

3110 <!-- /description -->

3111 </div><div class="apiItem">

3112 <a name="event-onAttached"></a>

3113 <h4>onAttached</h4>

3114 <div class="summary">

3115 <!-- Note: intentionally longer 80 columns -->

3116 <span class="subdued">chrome.tabs.</span><span>onAttached</span> <span class="subdued">.addListener</span>(function(<span>integer tabId, object a ttachInfo</span>) <span class="subdued">{...}</span><span></span>);

3117 </div>

3118 <div class="description">

3119 <p>Fired when a tab is attached to a window, for example because it was moved between windows.</p>

3120 <!-- LISTENER PARAMETERS -->

3121 <div>

3122 <h4>Listener parameters</h4>

3123 <dl>

3124 <div>

3125 <div>

3126 <dt>

3127 <var>tabId</var>

3128 <em>

3129 <!-- TYPE -->

3130 <div style="display:inline">

3131 (

3132 <span id="typeTemplate">

3133 <span>

3134 <span>integer</span>

3135 </span>

3136 </span>

3137 )

3138 </div>

3139 </em>

3140 </dt>

3141 <dd class="todo">

3142 Undocumented.

3143 </dd>

3144 <!-- OBJECT PROPERTIES -->

3145 <!-- OBJECT METHODS -->

3146 <!-- OBJECT EVENT FIELDS -->

3147 <!-- FUNCTION PARAMETERS -->

3148 </div>

3149 </div><div>

3150 <div>

3151 <dt>

3152 <var>attachInfo</var>

3153 <em>

3154 <!-- TYPE -->

3155 <div style="display:inline">

3156 (

3157 <span id="typeTemplate">

3158 <span>

3159 <span>object</span>

3160 </span>

3161 </span>

3162 )

3163 </div>

3164 </em>

3165 </dt>

3166 <dd class="todo">

3167 Undocumented.

3168 </dd>

3169 <!-- OBJECT PROPERTIES -->

3170 <dd>

3171 <dl>

3172 <div>

3173 <div>

3174 <dt>

3175 <var>newWindowId</var>

3176 <em>

3177 <!-- TYPE -->

3178 <div style="display:inline">

3179 (

3180 <span id="typeTemplate">

3181 <span>

3182 <span>integer</span>

3183 </span>

3184 </span>

3185 )

3186 </div>

3187 </em>

3188 </dt>

3189 <dd class="todo">

3190 Undocumented.

3191 </dd>

3192 <!-- OBJECT PROPERTIES -->

3193 <!-- OBJECT METHODS -->

3194 <!-- OBJECT EVENT FIELDS -->

3195 <!-- FUNCTION PARAMETERS -->

3196 </div>

3197 </div><div>

3198 <div>

3199 <dt>

3200 <var>newPosition</var>

3201 <em>

3202 <!-- TYPE -->

3203 <div style="display:inline">

3204 (

3205 <span id="typeTemplate">

3206 <span>

3207 <span>integer</span>

3208 </span>

3209 </span>

3210 )

3211 </div>

3212 </em>

3213 </dt>

3214 <dd class="todo">

3215 Undocumented.

3216 </dd>

3217 <!-- OBJECT PROPERTIES -->

3218 <!-- OBJECT METHODS -->

3219 <!-- OBJECT EVENT FIELDS -->

3220 <!-- FUNCTION PARAMETERS -->

3221 </div>

3222 </div>

3223 </dl>

3224 </dd>

3225 <!-- OBJECT METHODS -->

3226 <!-- OBJECT EVENT FIELDS -->

3227 <!-- FUNCTION PARAMETERS -->

3228 </div>

3229 </div>

3230 </dl>

3231 </div>

3232 <!-- EXTRA PARAMETERS -->

3233 <!-- LISTENER RETURN VALUE -->

3234 <dl>

3235 </dl>

3236 </div> <!-- /description -->

3237 <!-- /description -->

3238 </div><div class="apiItem">

3239 <a name="event-onCreated"></a>

3240 <h4>onCreated</h4>

3241 <div class="summary">

3242 <!-- Note: intentionally longer 80 columns -->

3243 <span class="subdued">chrome.tabs.</span><span>onCreated</span>< span class="subdued">.addListener</span>(function(<span>Tab tab</span>) <span cl ass="subdued">{...}</span><span></span>);

3244 </div>

3245 <div class="description">

3246 <p>Fired when a tab is created. Note that the tab's URL may not be set at the time this event fired, but you can listen to onUpdated events to b e notified when a URL is set.</p>

3247 <!-- LISTENER PARAMETERS -->

3248 <div>

3249 <h4>Listener parameters</h4>

3250 <dl>

3251 <div>

3252 <div>

3253 <dt>

3254 <var>tab</var>

3255 <em>

3256 <!-- TYPE -->

3257 <div style="display:inline">

3258 (

3259 <span id="typeTemplate">

3260 <span>

3261 <a href="tabs.html#type-Tab">Tab</a>

3262 </span>

3263 </span>

3264 )

3265 </div>

3266 </em>

3267 </dt>

3268 <dd>Details of the tab that was created.</dd>

3269 <!-- OBJECT PROPERTIES -->

3270 <!-- OBJECT METHODS -->

3271 <!-- OBJECT EVENT FIELDS -->

3272 <!-- FUNCTION PARAMETERS -->

3273 </div>

3274 </div>

3275 </dl>

3276 </div>

3277 <!-- EXTRA PARAMETERS -->

3278 <!-- LISTENER RETURN VALUE -->

3279 <dl>

3280 </dl>

3281 </div> <!-- /description -->

3282 <!-- /description -->

3283 </div><div class="apiItem">

3284 <a name="event-onDetached"></a>

3285 <h4>onDetached</h4>

3286 <div class="summary">

3287 <!-- Note: intentionally longer 80 columns -->

3288 <span class="subdued">chrome.tabs.</span><span>onDetached</span> <span class="subdued">.addListener</span>(function(<span>integer tabId, object d etachInfo</span>) <span class="subdued">{...}</span><span></span>);

3289 </div>

3290 <div class="description">

3291 <p>Fired when a tab is detached from a window, for example becau se it is being moved between windows.</p>

3292 <!-- LISTENER PARAMETERS -->

3293 <div>

3294 <h4>Listener parameters</h4>

3295 <dl>

3296 <div>

3297 <div>

3298 <dt>

3299 <var>tabId</var>

3300 <em>

3301 <!-- TYPE -->

3302 <div style="display:inline">

3303 (

3304 <span id="typeTemplate">

3305 <span>

3306 <span>integer</span>

3307 </span>

3308 </span>

3309 )

3310 </div>

3311 </em>

3312 </dt>

3313 <dd class="todo">

3314 Undocumented.

3315 </dd>

3316 <!-- OBJECT PROPERTIES -->

3317 <!-- OBJECT METHODS -->

3318 <!-- OBJECT EVENT FIELDS -->

3319 <!-- FUNCTION PARAMETERS -->

3320 </div>

3321 </div><div>

3322 <div>

3323 <dt>

3324 <var>detachInfo</var>

3325 <em>

3326 <!-- TYPE -->

3327 <div style="display:inline">

3328 (

3329 <span id="typeTemplate">

3330 <span>

3331 <span>object</span>

3332 </span>

3333 </span>

3334 )

3335 </div>

3336 </em>

3337 </dt>

3338 <dd class="todo">

3339 Undocumented.

3340 </dd>

3341 <!-- OBJECT PROPERTIES -->

3342 <dd>

3343 <dl>

3344 <div>

3345 <div>

3346 <dt>

3347 <var>oldWindowId</var>

3348 <em>

3349 <!-- TYPE -->

3350 <div style="display:inline">

3351 (

3352 <span id="typeTemplate">

3353 <span>

3354 <span>integer</span>

3355 </span>

3356 </span>

3357 )

3358 </div>

3359 </em>

3360 </dt>

3361 <dd class="todo">

3362 Undocumented.

3363 </dd>

3364 <!-- OBJECT PROPERTIES -->

3365 <!-- OBJECT METHODS -->

3366 <!-- OBJECT EVENT FIELDS -->

3367 <!-- FUNCTION PARAMETERS -->

3368 </div>

3369 </div><div>

3370 <div>

3371 <dt>

3372 <var>oldPosition</var>

3373 <em>

3374 <!-- TYPE -->

3375 <div style="display:inline">

3376 (

3377 <span id="typeTemplate">

3378 <span>

3379 <span>integer</span>

3380 </span>

3381 </span>

3382 )

3383 </div>

3384 </em>

3385 </dt>

3386 <dd class="todo">

3387 Undocumented.

3388 </dd>

3389 <!-- OBJECT PROPERTIES -->

3390 <!-- OBJECT METHODS -->

3391 <!-- OBJECT EVENT FIELDS -->

3392 <!-- FUNCTION PARAMETERS -->

3393 </div>

3394 </div>

3395 </dl>

3396 </dd>

3397 <!-- OBJECT METHODS -->

3398 <!-- OBJECT EVENT FIELDS -->

3399 <!-- FUNCTION PARAMETERS -->

3400 </div>

3401 </div>

3402 </dl>

3403 </div>

3404 <!-- EXTRA PARAMETERS -->

3405 <!-- LISTENER RETURN VALUE -->

3406 <dl>

3407 </dl>

3408 </div> <!-- /description -->

3409 <!-- /description -->

3410 </div><div class="apiItem">

3411 <a name="event-onHighlighted"></a>

3412 <h4>onHighlighted</h4>

3413 <div class="summary">

3414 <!-- Note: intentionally longer 80 columns -->

3415 <span class="subdued">chrome.tabs.</span><span>onHighlighted</sp an><span class="subdued">.addListener</span>(function(<span>object highlightInfo </span>) <span class="subdued">{...}</span><span></span>);

3416 </div>

3417 <div class="description">

3418 <p>Fired when the highlighted or selected tabs in a window chang es.</p>

3419 <!-- LISTENER PARAMETERS -->

3420 <div>

3421 <h4>Listener parameters</h4>

3422 <dl>

3423 <div>

3424 <div>

3425 <dt>

3426 <var>highlightInfo</var>

3427 <em>

3428 <!-- TYPE -->

3429 <div style="display:inline">

3430 (

3431 <span id="typeTemplate">

3432 <span>

3433 <span>object</span>

3434 </span>

3435 </span>

3436 )

3437 </div>

3438 </em>

3439 </dt>

3440 <dd class="todo">

3441 Undocumented.

3442 </dd>

3443 <!-- OBJECT PROPERTIES -->

3444 <dd>

3445 <dl>

3446 <div>

3447 <div>

3448 <dt>

3449 <var>windowId</var>

3450 <em>

3451 <!-- TYPE -->

3452 <div style="display:inline">

3453 (

3454 <span id="typeTemplate">

3455 <span>

3456 <span>integer</span>

3457 </span>

3458 </span>

3459 )

3460 </div>

3461 </em>

3462 </dt>

3463 <dd>The window whose tabs changed.</dd>

3464 <!-- OBJECT PROPERTIES -->

3465 <!-- OBJECT METHODS -->

3466 <!-- OBJECT EVENT FIELDS -->

3467 <!-- FUNCTION PARAMETERS -->

3468 </div>

3469 </div><div>

3470 <div>

3471 <dt>

3472 <var>tabIds</var>

3473 <em>

3474 <!-- TYPE -->

3475 <div style="display:inline">

3476 (

3477 <span id="typeTemplate">

3478 <span>

3479 <span>

3480 array of <span><span>

3481 <span>

3482 <span>integer</span>

3483 </span>

3484 </span></span>

3485 </span>

3486 </span>

3487 </span>

3488 )

3489 </div>

3490 </em>

3491 </dt>

3492 <dd>All highlighted tabs in the window.</dd>

3493 <!-- OBJECT PROPERTIES -->

3494 <!-- OBJECT METHODS -->

3495 <!-- OBJECT EVENT FIELDS -->

3496 <!-- FUNCTION PARAMETERS -->

3497 </div>

3498 </div>

3499 </dl>

3500 </dd>

3501 <!-- OBJECT METHODS -->

3502 <!-- OBJECT EVENT FIELDS -->

3503 <!-- FUNCTION PARAMETERS -->

3504 </div>

3505 </div>

3506 </dl>

3507 </div>

3508 <!-- EXTRA PARAMETERS -->

3509 <!-- LISTENER RETURN VALUE -->

3510 <dl>

3511 </dl>

3512 </div> <!-- /description -->

3513 <!-- /description -->

3514 </div><div class="apiItem">

3515 <a name="event-onMoved"></a>

3516 <h4>onMoved</h4>

3517 <div class="summary">

3518 <!-- Note: intentionally longer 80 columns -->

3519 <span class="subdued">chrome.tabs.</span><span>onMoved</span><sp an class="subdued">.addListener</span>(function(<span>integer tabId, object move Info</span>) <span class="subdued">{...}</span><span></span>);

3520 </div>

3521 <div class="description">

3522 <p>Fired when a tab is moved within a window. Only one move even t is fired, representing the tab the user directly moved. Move events are not fi red 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">onDeta ched</a>.</p>

3523 <!-- LISTENER PARAMETERS -->

3524 <div>

3525 <h4>Listener parameters</h4>

3526 <dl>

3527 <div>

3528 <div>

3529 <dt>

3530 <var>tabId</var>

3531 <em>

3532 <!-- TYPE -->

3533 <div style="display:inline">

3534 (

3535 <span id="typeTemplate">

3536 <span>

3537 <span>integer</span>

3538 </span>

3539 </span>

3540 )

3541 </div>

3542 </em>

3543 </dt>

3544 <dd class="todo">

3545 Undocumented.

3546 </dd>

3547 <!-- OBJECT PROPERTIES -->

3548 <!-- OBJECT METHODS -->

3549 <!-- OBJECT EVENT FIELDS -->

3550 <!-- FUNCTION PARAMETERS -->

3551 </div>

3552 </div><div>

3553 <div>

3554 <dt>

3555 <var>moveInfo</var>

3556 <em>

3557 <!-- TYPE -->

3558 <div style="display:inline">

3559 (

3560 <span id="typeTemplate">

3561 <span>

3562 <span>object</span>

3563 </span>

3564 </span>

3565 )

3566 </div>

3567 </em>

3568 </dt>

3569 <dd class="todo">

3570 Undocumented.

3571 </dd>

3572 <!-- OBJECT PROPERTIES -->

3573 <dd>

3574 <dl>

3575 <div>

3576 <div>

3577 <dt>

3578 <var>windowId</var>

3579 <em>

3580 <!-- TYPE -->

3581 <div style="display:inline">

3582 (

3583 <span id="typeTemplate">

3584 <span>

3585 <span>integer</span>

3586 </span>

3587 </span>

3588 )

3589 </div>

3590 </em>

3591 </dt>

3592 <dd class="todo">

3593 Undocumented.

3594 </dd>

3595 <!-- OBJECT PROPERTIES -->

3596 <!-- OBJECT METHODS -->

3597 <!-- OBJECT EVENT FIELDS -->

3598 <!-- FUNCTION PARAMETERS -->

3599 </div>

3600 </div><div>

3601 <div>

3602 <dt>

3603 <var>fromIndex</var>

3604 <em>

3605 <!-- TYPE -->

3606 <div style="display:inline">

3607 (

3608 <span id="typeTemplate">

3609 <span>

3610 <span>integer</span>

3611 </span>

3612 </span>

3613 )

3614 </div>

3615 </em>

3616 </dt>

3617 <dd class="todo">

3618 Undocumented.

3619 </dd>

3620 <!-- OBJECT PROPERTIES -->

3621 <!-- OBJECT METHODS -->

3622 <!-- OBJECT EVENT FIELDS -->

3623 <!-- FUNCTION PARAMETERS -->

3624 </div>

3625 </div><div>

3626 <div>

3627 <dt>

3628 <var>toIndex</var>

3629 <em>

3630 <!-- TYPE -->

3631 <div style="display:inline">

3632 (

3633 <span id="typeTemplate">

3634 <span>

3635 <span>integer</span>

3636 </span>

3637 </span>

3638 )

3639 </div>

3640 </em>

3641 </dt>

3642 <dd class="todo">

3643 Undocumented.

3644 </dd>

3645 <!-- OBJECT PROPERTIES -->

3646 <!-- OBJECT METHODS -->

3647 <!-- OBJECT EVENT FIELDS -->

3648 <!-- FUNCTION PARAMETERS -->

3649 </div>

3650 </div>

3651 </dl>

3652 </dd>

3653 <!-- OBJECT METHODS -->

3654 <!-- OBJECT EVENT FIELDS -->

3655 <!-- FUNCTION PARAMETERS -->

3656 </div>

3657 </div>

3658 </dl>

3659 </div>

3660 <!-- EXTRA PARAMETERS -->

3661 <!-- LISTENER RETURN VALUE -->

3662 <dl>

3663 </dl>

3664 </div> <!-- /description -->

3665 <!-- /description -->

3666 </div><div class="apiItem">

3667 <a name="event-onRemoved"></a>

3668 <h4>onRemoved</h4>

3669 <div class="summary">

3670 <!-- Note: intentionally longer 80 columns -->

3671 <span class="subdued">chrome.tabs.</span><span>onRemoved</span>< span class="subdued">.addListener</span>(function(<span>integer tabId, object re moveInfo</span>) <span class="subdued">{...}</span><span></span>);

3672 </div>

3673 <div class="description">

3674 <p>Fired when a tab is closed. Note: A listener can be registere d for this event without requesting the 'tabs' permission in the manifest.</p>

3675 <!-- LISTENER PARAMETERS -->

3676 <div>

3677 <h4>Listener parameters</h4>

3678 <dl>

3679 <div>

3680 <div>

3681 <dt>

3682 <var>tabId</var>

3683 <em>

3684 <!-- TYPE -->

3685 <div style="display:inline">

3686 (

3687 <span id="typeTemplate">

3688 <span>

3689 <span>integer</span>

3690 </span>

3691 </span>

3692 )

3693 </div>

3694 </em>

3695 </dt>

3696 <dd class="todo">

3697 Undocumented.

3698 </dd>

3699 <!-- OBJECT PROPERTIES -->

3700 <!-- OBJECT METHODS -->

3701 <!-- OBJECT EVENT FIELDS -->

3702 <!-- FUNCTION PARAMETERS -->

3703 </div>

3704 </div><div>

3705 <div>

3706 <dt>

3707 <var>removeInfo</var>

3708 <em>

3709 <!-- TYPE -->

3710 <div style="display:inline">

3711 (

3712 <span id="typeTemplate">

3713 <span>

3714 <span>object</span>

3715 </span>

3716 </span>

3717 )

3718 </div>

3719 </em>

3720 </dt>

3721 <dd class="todo">

3722 Undocumented.

3723 </dd>

3724 <!-- OBJECT PROPERTIES -->

3725 <dd>

3726 <dl>

3727 <div>

3728 <div>

3729 <dt>

3730 <var>isWindowClosing</var>

3731 <em>

3732 <!-- TYPE -->

3733 <div style="display:inline">

3734 (

3735 <span id="typeTemplate">

3736 <span>

3737 <span>boolean</span>

3738 </span>

3739 </span>

3740 )

3741 </div>

3742 </em>

3743 </dt>

3744 <dd>True when the tab is being closed because its window is being clos ed.</dd>

3745 <!-- OBJECT PROPERTIES -->

3746 <!-- OBJECT METHODS -->

3747 <!-- OBJECT EVENT FIELDS -->

3748 <!-- FUNCTION PARAMETERS -->

3749 </div>

3750 </div>

3751 </dl>

3752 </dd>

3753 <!-- OBJECT METHODS -->

3754 <!-- OBJECT EVENT FIELDS -->

3755 <!-- FUNCTION PARAMETERS -->

3756 </div>

3757 </div>

3758 </dl>

3759 </div>

3760 <!-- EXTRA PARAMETERS -->

3761 <!-- LISTENER RETURN VALUE -->

3762 <dl>

3763 </dl>

3764 </div> <!-- /description -->

3765 <!-- /description -->

3766 </div><div class="apiItem">

3767 <a name="event-onUpdated"></a>

3768 <h4>onUpdated</h4>

3769 <div class="summary">

3770 <!-- Note: intentionally longer 80 columns -->

3771 <span class="subdued">chrome.tabs.</span><span>onUpdated</span>< span class="subdued">.addListener</span>(function(<span>integer tabId, object ch angeInfo, Tab tab</span>) <span class="subdued">{...}</span><span></span>);

3772 </div>

3773 <div class="description">

3774 <p>Fired when a tab is updated.</p>

3775 <!-- LISTENER PARAMETERS -->

3776 <div>

3777 <h4>Listener parameters</h4>

3778 <dl>

3779 <div>

3780 <div>

3781 <dt>

3782 <var>tabId</var>

3783 <em>

3784 <!-- TYPE -->

3785 <div style="display:inline">

3786 (

3787 <span id="typeTemplate">

3788 <span>

3789 <span>integer</span>

3790 </span>

3791 </span>

3792 )

3793 </div>

3794 </em>

3795 </dt>

3796 <dd class="todo">

3797 Undocumented.

3798 </dd>

3799 <!-- OBJECT PROPERTIES -->

3800 <!-- OBJECT METHODS -->

3801 <!-- OBJECT EVENT FIELDS -->

3802 <!-- FUNCTION PARAMETERS -->

3803 </div>

3804 </div><div>

3805 <div>

3806 <dt>

3807 <var>changeInfo</var>

3808 <em>

3809 <!-- TYPE -->

3810 <div style="display:inline">

3811 (

3812 <span id="typeTemplate">

3813 <span>

3814 <span>object</span>

3815 </span>

3816 </span>

3817 )

3818 </div>

3819 </em>

3820 </dt>

3821 <dd>Lists the changes to the state of the tab that was updated.</dd>

3822 <!-- OBJECT PROPERTIES -->

3823 <dd>

3824 <dl>

3825 <div>

3826 <div>

3827 <dt>

3828 <var>status</var>

3829 <em>

3830 <!-- TYPE -->

3831 <div style="display:inline">

3832 (

3833 <span class="optional">optional</span>

3834 <span id="typeTemplate">

3835 <span>

3836 <span>string</span>

3837 </span>

3838 </span>

3839 )

3840 </div>

3841 </em>

3842 </dt>

3843 <dd>The status of the tab. Can be either <em>loading</em> or <em>compl ete</em>.</dd>

3844 <!-- OBJECT PROPERTIES -->

3845 <!-- OBJECT METHODS -->

3846 <!-- OBJECT EVENT FIELDS -->

3847 <!-- FUNCTION PARAMETERS -->

3848 </div>

3849 </div><div>

3850 <div>

3851 <dt>

3852 <var>url</var>

3853 <em>

3854 <!-- TYPE -->

3855 <div style="display:inline">

3856 (

3857 <span class="optional">optional</span>

3858 <span id="typeTemplate">

3859 <span>

3860 <span>string</span>

3861 </span>

3862 </span>

3863 )

3864 </div>

3865 </em>

3866 </dt>

3867 <dd>The tab's URL if it has changed.</dd>

3868 <!-- OBJECT PROPERTIES -->

3869 <!-- OBJECT METHODS -->

3870 <!-- OBJECT EVENT FIELDS -->

3871 <!-- FUNCTION PARAMETERS -->

3872 </div>

3873 </div><div>

3874 <div>

3875 <dt>

3876 <var>pinned</var>

3877 <em>

3878 <!-- TYPE -->

3879 <div style="display:inline">

3880 (

3881 <span class="optional">optional</span>

3882 <span id="typeTemplate">

3883 <span>

3884 <span>boolean</span>

3885 </span>

3886 </span>

3887 )

3888 </div>

3889 </em>

3890 </dt>

3891 <dd>The tab's new pinned state.</dd>

3892 <!-- OBJECT PROPERTIES -->

3893 <!-- OBJECT METHODS -->

3894 <!-- OBJECT EVENT FIELDS -->

3895 <!-- FUNCTION PARAMETERS -->

3896 </div>

3897 </div>

3898 </dl>

3899 </dd>

3900 <!-- OBJECT METHODS -->

3901 <!-- OBJECT EVENT FIELDS -->

3902 <!-- FUNCTION PARAMETERS -->

3903 </div>

3904 </div><div>

3905 <div>

3906 <dt>

3907 <var>tab</var>

3908 <em>

3909 <!-- TYPE -->

3910 <div style="display:inline">

3911 (

3912 <span id="typeTemplate">

3913 <span>

3914 <a href="tabs.html#type-Tab">Tab</a>

3915 </span>

3916 </span>

3917 )

3918 </div>

3919 </em>

3920 </dt>

3921 <dd>Gives the state of the tab that was updated.</dd>

3922 <!-- OBJECT PROPERTIES -->

3923 <!-- OBJECT METHODS -->

3924 <!-- OBJECT EVENT FIELDS -->

3925 <!-- FUNCTION PARAMETERS -->

3926 </div>

3927 </div>

3928 </dl>

3929 </div>

3930 <!-- EXTRA PARAMETERS -->

3931 <!-- LISTENER RETURN VALUE -->

3932 <dl>

3933 </dl>

3934 </div> <!-- /description -->

3935 <!-- /description -->

3936 </div> <!-- /apiItem -->

3937 </div> <!-- /apiGroup -->

3938 <!-- TYPES -->

3939 <div class="apiGroup">

3940 <a name="types"></a>

3941 <h3 id="types">Types</h3>

3942 <!-- iterates over all types -->

3943 <div class="apiItem">

3944 <a name="type-Tab"></a>

3945 <h4>Tab</h4>

3946 <div>

3947 <dt>

3948 <em>

3949 <!-- TYPE -->

3950 <div style="display:inline">

3951 (

3952 <span id="typeTemplate">

3953 <span>

3954 <span>object</span>

3955 </span>

3956 </span>

3957 )

3958 </div>

3959 </em>

3960 </dt>

3961 <dd class="todo">

3962 Undocumented.

3963 </dd>

3964 <!-- OBJECT PROPERTIES -->

3965 <dd>

3966 <dl>

3967 <div>

3968 <div>

3969 <dt>

3970 <var>id</var>

3971 <em>

3972 <!-- TYPE -->

3973 <div style="display:inline">

3974 (

3975 <span id="typeTemplate">

3976 <span>

3977 <span>integer</span>

3978 </span>

3979 </span>

3980 )

3981 </div>

3982 </em>

3983 </dt>

3984 <dd>The ID of the tab. Tab IDs are unique within a browser session.</d d>

3985 <!-- OBJECT PROPERTIES -->

3986 <!-- OBJECT METHODS -->

3987 <!-- OBJECT EVENT FIELDS -->

3988 <!-- FUNCTION PARAMETERS -->

3989 </div>

3990 </div><div>

3991 <div>

3992 <dt>

3993 <var>index</var>

3994 <em>

3995 <!-- TYPE -->

3996 <div style="display:inline">

3997 (

3998 <span id="typeTemplate">

3999 <span>

4000 <span>integer</span>

4001 </span>

4002 </span>

4003 )

4004 </div>

4005 </em>

4006 </dt>

4007 <dd>The zero-based index of the tab within its window.</dd>

4008 <!-- OBJECT PROPERTIES -->

4009 <!-- OBJECT METHODS -->

4010 <!-- OBJECT EVENT FIELDS -->

4011 <!-- FUNCTION PARAMETERS -->

4012 </div>

4013 </div><div>

4014 <div>

4015 <dt>

4016 <var>windowId</var>

4017 <em>

4018 <!-- TYPE -->

4019 <div style="display:inline">

4020 (

4021 <span id="typeTemplate">

4022 <span>

4023 <span>integer</span>

4024 </span>

4025 </span>

4026 )

4027 </div>

4028 </em>

4029 </dt>

4030 <dd>The ID of the window the tab is contained within.</dd>

4031 <!-- OBJECT PROPERTIES -->

4032 <!-- OBJECT METHODS -->

4033 <!-- OBJECT EVENT FIELDS -->

4034 <!-- FUNCTION PARAMETERS -->

4035 </div>

4036 </div><div>

4037 <div>

4038 <dt>

4039 <var>openerTabId</var>

4040 <em>

4041 <!-- TYPE -->

4042 <div style="display:inline">

4043 (

4044 <span class="optional">optional</span>

4045 <span id="typeTemplate">

4046 <span>

4047 <span>integer</span>

4048 </span>

4049 </span>

4050 )

4051 </div>

4052 </em>

4053 </dt>

4054 <dd>The ID of the tab that opened this tab, if any. This will only be present if the opener tab still exists.</dd>

4055 <!-- OBJECT PROPERTIES -->

4056 <!-- OBJECT METHODS -->

4057 <!-- OBJECT EVENT FIELDS -->

4058 <!-- FUNCTION PARAMETERS -->

4059 </div>

4060 </div><div>

4061 <div>

4062 <dt>

4063 <var>highlighted</var>

4064 <em>

4065 <!-- TYPE -->

4066 <div style="display:inline">

4067 (

4068 <span id="typeTemplate">

4069 <span>

4070 <span>boolean</span>

4071 </span>

4072 </span>

4073 )

4074 </div>

4075 </em>

4076 </dt>

4077 <dd>Whether the tab is highlighted.</dd>

4078 <!-- OBJECT PROPERTIES -->

4079 <!-- OBJECT METHODS -->

4080 <!-- OBJECT EVENT FIELDS -->

4081 <!-- FUNCTION PARAMETERS -->

4082 </div>

4083 </div><div>

4084 <div>

4085 <dt>

4086 <var>active</var>

4087 <em>

4088 <!-- TYPE -->

4089 <div style="display:inline">

4090 (

4091 <span id="typeTemplate">

4092 <span>

4093 <span>boolean</span>

4094 </span>

4095 </span>

4096 )

4097 </div>

4098 </em>

4099 </dt>

4100 <dd>Whether the tab is active in its window.</dd>

4101 <!-- OBJECT PROPERTIES -->

4102 <!-- OBJECT METHODS -->

4103 <!-- OBJECT EVENT FIELDS -->

4104 <!-- FUNCTION PARAMETERS -->

4105 </div>

4106 </div><div>

4107 <div>

4108 <dt>

4109 <var>pinned</var>

4110 <em>

4111 <!-- TYPE -->

4112 <div style="display:inline">

4113 (

4114 <span id="typeTemplate">

4115 <span>

4116 <span>boolean</span>

4117 </span>

4118 </span>

4119 )

4120 </div>

4121 </em>

4122 </dt>

4123 <dd>Whether the tab is pinned.</dd>

4124 <!-- OBJECT PROPERTIES -->

4125 <!-- OBJECT METHODS -->

4126 <!-- OBJECT EVENT FIELDS -->

4127 <!-- FUNCTION PARAMETERS -->

4128 </div>

4129 </div><div>

4130 <div>

4131 <dt>

4132 <var>url</var>

4133 <em>

4134 <!-- TYPE -->

4135 <div style="display:inline">

4136 (

4137 <span id="typeTemplate">

4138 <span>

4139 <span>string</span>

4140 </span>

4141 </span>

4142 )

4143 </div>

4144 </em>

4145 </dt>

4146 <dd>The URL the tab is displaying.</dd>

4147 <!-- OBJECT PROPERTIES -->

4148 <!-- OBJECT METHODS -->

4149 <!-- OBJECT EVENT FIELDS -->

4150 <!-- FUNCTION PARAMETERS -->

4151 </div>

4152 </div><div>

4153 <div>

4154 <dt>

4155 <var>title</var>

4156 <em>

4157 <!-- TYPE -->

4158 <div style="display:inline">

4159 (

4160 <span class="optional">optional</span>

4161 <span id="typeTemplate">

4162 <span>

4163 <span>string</span>

4164 </span>

4165 </span>

4166 )

4167 </div>

4168 </em>

4169 </dt>

4170 <dd>The title of the tab. This may not be available if the tab is load ing.</dd>

4171 <!-- OBJECT PROPERTIES -->

4172 <!-- OBJECT METHODS -->

4173 <!-- OBJECT EVENT FIELDS -->

4174 <!-- FUNCTION PARAMETERS -->

4175 </div>

4176 </div><div>

4177 <div>

4178 <dt>

4179 <var>favIconUrl</var>

4180 <em>

4181 <!-- TYPE -->

4182 <div style="display:inline">

4183 (

4184 <span class="optional">optional</span>

4185 <span id="typeTemplate">

4186 <span>

4187 <span>string</span>

4188 </span>

4189 </span>

4190 )

4191 </div>

4192 </em>

4193 </dt>

4194 <dd>The URL of the tab's favicon. This may not be available if the tab is loading.</dd>

4195 <!-- OBJECT PROPERTIES -->

4196 <!-- OBJECT METHODS -->

4197 <!-- OBJECT EVENT FIELDS -->

4198 <!-- FUNCTION PARAMETERS -->

4199 </div>

4200 </div><div>

4201 <div>

4202 <dt>

4203 <var>status</var>

4204 <em>

4205 <!-- TYPE -->

4206 <div style="display:inline">

4207 (

4208 <span class="optional">optional</span>

4209 <span id="typeTemplate">

4210 <span>

4211 <span>string</span>

4212 </span>

4213 </span>

4214 )

4215 </div>

4216 </em>

4217 </dt>

4218 <dd>Either <em>loading</em> or <em>complete</em>.</dd>

4219 <!-- OBJECT PROPERTIES -->

4220 <!-- OBJECT METHODS -->

4221 <!-- OBJECT EVENT FIELDS -->

4222 <!-- FUNCTION PARAMETERS -->

4223 </div>

4224 </div><div>

4225 <div>

4226 <dt>

4227 <var>incognito</var>

4228 <em>

4229 <!-- TYPE -->

4230 <div style="display:inline">

4231 (

4232 <span id="typeTemplate">

4233 <span>

4234 <span>boolean</span>

4235 </span>

4236 </span>

4237 )

4238 </div>

4239 </em>

4240 </dt>

4241 <dd>Whether the tab is in an incognito window.</dd>

4242 <!-- OBJECT PROPERTIES -->

4243 <!-- OBJECT METHODS -->

4244 <!-- OBJECT EVENT FIELDS -->

4245 <!-- FUNCTION PARAMETERS -->

4246 </div>

4247 </div>

4248 </dl>

4249 </dd>

4250 <!-- OBJECT METHODS -->

4251 <!-- OBJECT EVENT FIELDS -->

4252 <!-- FUNCTION PARAMETERS -->

4253 </div>

4254 </div> <!-- /apiItem -->

4255 </div> <!-- /apiGroup -->

4256 </div> <!-- /apiPage -->

4257 </div> <!-- /gc-pagecontent -->

4258 </div> <!-- /g-section -->

4259 </div> <!-- /codesiteContent -->

4260 <div id="gc-footer" --="">

4261 <div class="text">

4262 <p>

4263 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,

4264 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons

4265 Attribution 3.0 License</a>, and code samples are licensed under the

4266 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.

4267 </p>

4268 <p>

4269 ©2011 Google

4270 </p>

4271 <!-- begin analytics -->

4272 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>

4273 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>

4274 <script type="text/javascript">

4275 // chrome doc tracking

4276 try {

4277 var engdocs = _gat._getTracker("YT-10763712-2");

4278 engdocs._trackPageview();

4279 } catch(err) {}

4280 // code.google.com site-wide tracking

4281 try {

4282 _uacct="UA-18071-1";

4283 _uanchor=1;

4284 _uff=0;

4285 urchinTracker();

4286 }

4287 catch(e) {/* urchinTracker not available. */}

4288 </script>

4289 <!-- end analytics -->

4290 </div>

4291 </div> <!-- /gc-footer -->

4292 </div> <!-- /gc-container -->

4293 </body></html>

OLD	NEW

« no previous file with comments | « chrome/common/extensions/docs/storage.html ('k') | chrome/common/extensions/docs/template/api_template_apps.html » ('j') | no next file with comments »