chrome/common/extensions/docs/experimental.savePage.html - Issue 8682013: Moving the MHTML API out of experimental and renaming it.

Side by Side Diff: chrome/common/extensions/docs/experimental.savePage.html

Issue 8682013: Moving the MHTML API out of experimental and renaming it. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 9 years 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="js/api_page_generator.js"></script>

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

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

19 <title>chrome.experimental.savePage - Google Chrome Extensions - Google Code</ title></head>

20 <body> <div id="gc-container" class="labs">

21 <div id="devModeWarning">

22 You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with -- allow-file-access-from-files.

23 </div>

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

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

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

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

28 <div style="display:none">

29

30 <!-- VALUE -->

31 <div id="valueTemplate">

32 <dt>

33 <var>paramName</var>

34 <em>

35

36 <!-- TYPE -->

37 <div style="display:inline">

38 (

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

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

41 <span id="typeTemplate">

42 <span>

43 <a> Type</a>

44 </span>

45 <span>

46 <span>

47 array of <span><span></span></span>

48 </span>

49 <span>paramType</span>

50 <span></span>

51 </span>

52 </span>

53 )

54 </div>

55

56 </em>

57 </dt>

58 <dd class="todo">

59 Undocumented.

60 </dd>

61 <dd>

62 Description of this parameter from the json schema.

63 </dd>

64 <dd>

65 This parameter was added in version

66 <b><span></span></b>.

67 You must omit this parameter in earlier versions,

68 and you may omit it in any version. If you require this

69 parameter, the manifest key

70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

71 can ensure that your extension won't be run in an earlier browser ve rsion.

72 </dd>

73

74 <!-- OBJECT PROPERTIES -->

75 <dd>

76 <dl>

77 <div>

78 <div>

79 </div>

80 </div>

81 </dl>

82 </dd>

83

84 <!-- OBJECT METHODS -->

85 <dd>

86 <div></div>

87 </dd>

88

89 <!-- OBJECT EVENT FIELDS -->

90 <dd>

91 <div></div>

92 </dd>

93

94 <!-- FUNCTION PARAMETERS -->

95 <dd>

96 <div></div>

97 </dd>

98

99 </div> <!-- /VALUE -->

100

101 <div id="functionParametersTemplate">

102 <h5>Parameters</h5>

103 <dl>

104 <div>

105 <div>

106 </div>

107 </div>

108 </dl>

109 </div>

110

111 <!-- Individual subsections from the table of contents -->

112 <ol>

113 <li id="propertiesTocTemplate">

114 <a href="#properties">Properties</a>

115 <ol>

116 <li>

117 <a href="#property-anchor">propertyName</a>

118 </li>

119 </ol>

120 </li>

121 <li id="methodsTocTemplate">

122 <a>Methods</a>

123 <ol>

124 <li>

125 <a href="#method-anchor">methodName</a>

126 </li>

127 </ol>

128 </li>

129 <li id="eventsTocTemplate">

130 <a>Events</a>

131 <ol>

132 <li>

133 <a href="#event-anchor">eventName</a>

134 </li>

135 </ol>

136 </li>

137 <li id="typesTocTemplate">

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

139 <ol>

140 <li>

141 <a href="#id-anchor">id</a>

142 <ol>

143 <div></div>

144 <div></div>

145 </ol>

146 </li>

147 </ol>

148 </li>

149 </ol>

150 </div> <!-- /SUBTEMPLATES -->

151

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

153 <div id="skipto">

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

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

156 </div>

157 <!-- API HEADER -->

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

159 <tbody><tr>

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

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

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

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

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

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

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

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

168 <br>

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

170 </div>

171 </form>

172

173 <script type="text/javascript" src="http://www.google.com/jsapi"></scr ipt>

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

175 <script type="text/javascript" src="http://www.google.com/coop/cse/t13 n?form=cse&t13n_langs=en"></script>

176 <script type="text/javascript" src="http://www.google.com/coop/cse/bra nd?form=cse&lang=en"></script>

177 </td>

178 </tr>

179 </tbody></table>

180

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

182

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

184 <div id="gc-topnav">

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

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

187 <li id="home_link">

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

189 </li>

190 <li id="docs_link">

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

192 </li>

193 <li id="faq_link">

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

195 </li>

196 <li id="samples_link">

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

198 </li>

199 <li id="group_link">

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

201 </li>

202 <li id="so_link">

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

204 </li>

205 </ul>

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

207

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

209 <!-- SIDENAV -->

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

211 <ul>

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

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

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

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

216 <ul>

217 <li>Browser UI

218 <ul>

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

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

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

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

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

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

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

226 </ul>

227 </li>

228 <li>Browser Interaction

229 <ul>

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

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

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

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

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

235 <li><a href="tabs.html">Tabs</a></li>

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

237 </ul>

238 </li>

239 <li>Implementation

240 <ul>

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

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

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

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

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

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

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

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

249 </ul>

250 </li>

251 <li>Finishing

252 <ul>

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

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

255 </ul>

256 </li>

257 </ul>

258 </li>

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

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

261 <ul>

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

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

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

265 </ul>

266 </li>

267 <li><h2>Reference</h2>

268 <ul>

269 <li>Formats

270 <ul>

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

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

273 </ul>

274 </li>

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

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

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

278 </ul>

279 </li>

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

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

282 <li><h2>More</h2>

283 <ul>

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

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

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

287 </ul>

288 </li>

289 </ul>

290 </div>

291 <script>

292 initToggles();

293 </script>

294

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

296 <div id="pageTitle">

297 <h1 class="page_title">chrome.experimental.savePage</h1>

298 </div>

299 <!-- TABLE OF CONTENTS -->

300 <div id="toc">

301 <h2>Contents</h2>

302 <ol>

303 <li>

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

305 <ol>

306 <li style="display: none; ">

307 <a>h3Name</a>

308 </li>

309 </ol>

310 </li>

311 <li>

312 <a href="#apiReference">API reference: chrome.experimental.saveP age</a>

313 <ol>

314 <li style="display: none; ">

315 <a href="#properties">Properties</a>

316 <ol>

317 <li>

318 <a href="#property-anchor">propertyName</a>

319 </li>

320 </ol>

321 </li>

322 <li>

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

324 <ol>

325 <li>

326 <a href="#method-saveAsMHTML">saveAsMHTML</a>

327 </li>

328 </ol>

329 </li>

330 <li style="display: none; ">

331 <a>Events</a>

332 <ol>

333 <li>

334 <a href="#event-anchor">eventName</a>

335 </li>

336 </ol>

337 </li>

338 <li style="display: none; ">

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

340 <ol>

341 <li>

342 <a href="#id-anchor">id</a>

343 <ol>

344 <div></div>

345 <div></div>

346 </ol>

347 </li>

348 </ol>

349 </li>

350 </ol>

351 </li>

352 </ol>

353 </div>

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

355

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

357 <p id="classSummary">

358 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.

359 </p>

360

361 <!-- STATIC CONTENT PLACEHOLDER -->

362 <div id="static"><!-- BEGIN AUTHORED CONTENT -->

363 <p>

364 The savePage API allows you to save a tab as MHTML.

365 </p>

366

367 <p>

368 MHTML is a <a href="http://tools.ietf.org/html/rfc2557">standard format</a>

369 supported by most browsers. It encapsulates in a single file a page and all

370 its resources (CSS files, images..).

371 </p>

372

373 <p>

374 Note that for security reasons a MHTML file can only be loaded from the file

375 system and that it can only be loaded in the main frame.

376 </p>

377

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

379

380 <p>

381 The savePage API is currently

382 experimental, so you must declare the "experimental"

383 permission to use it.

384

385 <!-- END AUTHORED CONTENT -->

386 </p></div>

387

388 <!-- API PAGE -->

389 <div class="apiPage">

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

391 <h2>API reference: chrome.experimental.savePage</h2>

392

393 <!-- PROPERTIES -->

394 <div class="apiGroup" style="display: none; ">

395 <a name="properties"></a>

396 <h3 id="properties">Properties</h3>

397

398 <div>

399 <a></a>

400 <h4>getLastError</h4>

401 <div class="summary">

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

403 <span>chrome.extension</span><span>lastError</span>

404 </div>

405 <div>

406 </div>

407 </div>

408

409 </div> <!-- /apiGroup -->

410

411 <!-- METHODS -->

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

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

414 <h3>Methods</h3>

415

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

417 <div class="apiItem">

418 <a name="method-saveAsMHTML"></a> <!-- method-anchor -->

419 <h4>saveAsMHTML</h4>

420

421 <div class="summary"><span style="display: none; ">void</span>

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

423 <span>chrome.experimental.savePage.saveAsMHTML</span>(<span cl ass="null"><span style="display: none; ">, </span><span>object</span>

424 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>

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

426

427 <div class="description">

428 <p class="todo" style="display: none; ">Undocumented.</p>

429 <p>Saves the content of the tab with given id as MHTML.</p>

430

431 <!-- PARAMETERS -->

432 <h4>Parameters</h4>

433 <dl>

434 <div>

435 <div>

436 <dt>

437 <var>details</var>

438 <em>

439

440 <!-- TYPE -->

441 <div style="display:inline">

442 (

443 <span class="optional" style="display: none; ">optional</spa n>

444 <span class="enum" style="display: none; ">enumerated</span>

445 <span id="typeTemplate">

446 <span style="display: none; ">

447 <a> Type</a>

448 </span>

449 <span>

450 <span style="display: none; ">

451 array of <span><span></span></span>

452 </span>

453 <span>object</span>

454 <span style="display: none; "></span>

455 </span>

456 </span>

457 )

458 </div>

459

460 </em>

461 </dt>

462 <dd class="todo">

463 Undocumented.

464 </dd>

465 <dd style="display: none; ">

466 Description of this parameter from the json schema.

467 </dd>

468 <dd style="display: none; ">

469 This parameter was added in version

470 <b><span></span></b>.

471 You must omit this parameter in earlier versions,

472 and you may omit it in any version. If you require this

473 parameter, the manifest key

474 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

475 can ensure that your extension won't be run in an earlier browser ve rsion.

476 </dd>

477

478 <!-- OBJECT PROPERTIES -->

479 <dd>

480 <dl>

481 <div>

482 <div>

483 <dt>

484 <var>tabId</var>

485 <em>

486

487 <!-- TYPE -->

488 <div style="display:inline">

489 (

490 <span class="optional" style="display: none; ">optional</spa n>

491 <span class="enum" style="display: none; ">enumerated</span>

492 <span id="typeTemplate">

493 <span style="display: none; ">

494 <a> Type</a>

495 </span>

496 <span>

497 <span style="display: none; ">

498 array of <span><span></span></span>

499 </span>

500 <span>integer</span>

501 <span style="display: none; "></span>

502 </span>

503 </span>

504 )

505 </div>

506

507 </em>

508 </dt>

509 <dd class="todo" style="display: none; ">

510 Undocumented.

511 </dd>

512 <dd>The id of the tab to save as MHTML.</dd>

513 <dd style="display: none; ">

514 This parameter was added in version

515 <b><span></span></b>.

516 You must omit this parameter in earlier versions,

517 and you may omit it in any version. If you require this

518 parameter, the manifest key

519 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

520 can ensure that your extension won't be run in an earlier browser ve rsion.

521 </dd>

522

523 <!-- OBJECT PROPERTIES -->

524 <dd style="display: none; ">

525 <dl>

526 <div>

527 <div>

528 </div>

529 </div>

530 </dl>

531 </dd>

532

533 <!-- OBJECT METHODS -->

534 <dd style="display: none; ">

535 <div></div>

536 </dd>

537

538 <!-- OBJECT EVENT FIELDS -->

539 <dd style="display: none; ">

540 <div></div>

541 </dd>

542

543 <!-- FUNCTION PARAMETERS -->

544 <dd style="display: none; ">

545 <div></div>

546 </dd>

547

548 </div>

549 </div>

550 </dl>

551 </dd>

552

553 <!-- OBJECT METHODS -->

554 <dd style="display: none; ">

555 <div></div>

556 </dd>

557

558 <!-- OBJECT EVENT FIELDS -->

559 <dd style="display: none; ">

560 <div></div>

561 </dd>

562

563 <!-- FUNCTION PARAMETERS -->

564 <dd style="display: none; ">

565 <div></div>

566 </dd>

567

568 </div>

569 </div><div>

570 <div>

571 <dt>

572 <var>callback</var>

573 <em>

574

575 <!-- TYPE -->

576 <div style="display:inline">

577 (

578 <span class="optional" style="display: none; ">optional</spa n>

579 <span class="enum" style="display: none; ">enumerated</span>

580 <span id="typeTemplate">

581 <span style="display: none; ">

582 <a> Type</a>

583 </span>

584 <span>

585 <span style="display: none; ">

586 array of <span><span></span></span>

587 </span>

588 <span>function</span>

589 <span style="display: none; "></span>

590 </span>

591 </span>

592 )

593 </div>

594

595 </em>

596 </dt>

597 <dd class="todo" style="display: none; ">

598 Undocumented.

599 </dd>

600 <dd>Called when the MHTML has been generated.</dd>

601 <dd style="display: none; ">

602 This parameter was added in version

603 <b><span></span></b>.

604 You must omit this parameter in earlier versions,

605 and you may omit it in any version. If you require this

606 parameter, the manifest key

607 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

608 can ensure that your extension won't be run in an earlier browser ve rsion.

609 </dd>

610

611 <!-- OBJECT PROPERTIES -->

612 <dd style="display: none; ">

613 <dl>

614 <div>

615 <div>

616 </div>

617 </div>

618 </dl>

619 </dd>

620

621 <!-- OBJECT METHODS -->

622 <dd style="display: none; ">

623 <div></div>

624 </dd>

625

626 <!-- OBJECT EVENT FIELDS -->

627 <dd style="display: none; ">

628 <div></div>

629 </dd>

630

631 <!-- FUNCTION PARAMETERS -->

632 <dd style="display: none; ">

633 <div></div>

634 </dd>

635

636 </div>

637 </div>

638 </dl>

639

640 <!-- RETURNS -->

641 <h4 style="display: none; ">Returns</h4>

642 <dl>

643 <div style="display: none; ">

644 <div>

645 </div>

646 </div>

647 </dl>

648

649 <!-- CALLBACK -->

650 <div>

651 <div>

652 <h4>Callback function</h4>

653 <p>

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

655 that looks like this:

656 </p>

657 <p style="display: none; ">

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

659 specify a function that looks like this:

660 </p>

661

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

663 <pre>function(<span>blob mhtmlData</span>) <span class="subdue d">{...}</span>;</pre>

664 <dl>

665 <div>

666 <div>

667 <dt>

668 <var>mhtmlData</var>

669 <em>

670

671 <!-- TYPE -->

672 <div style="display:inline">

673 (

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

675 <span class="enum" style="display: none; ">enumerated</span>

676 <span id="typeTemplate">

677 <span style="display: none; ">

678 <a> Type</a>

679 </span>

680 <span>

681 <span style="display: none; ">

682 array of <span><span></span></span>

683 </span>

684 <span>blob</span>

685 <span style="display: none; "></span>

686 </span>

687 </span>

688 )

689 </div>

690

691 </em>

692 </dt>

693 <dd class="todo" style="display: none; ">

694 Undocumented.

695 </dd>

696 <dd>The MHTML data as a Blob.</dd>

697 <dd style="display: none; ">

698 This parameter was added in version

699 <b><span></span></b>.

700 You must omit this parameter in earlier versions,

701 and you may omit it in any version. If you require this

702 parameter, the manifest key

703 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>

704 can ensure that your extension won't be run in an earlier browser ve rsion.

705 </dd>

706

707 <!-- OBJECT PROPERTIES -->

708 <dd style="display: none; ">

709 <dl>

710 <div>

711 <div>

712 </div>

713 </div>

714 </dl>

715 </dd>

716

717 <!-- OBJECT METHODS -->

718 <dd style="display: none; ">

719 <div></div>

720 </dd>

721

722 <!-- OBJECT EVENT FIELDS -->

723 <dd style="display: none; ">

724 <div></div>

725 </dd>

726

727 <!-- FUNCTION PARAMETERS -->

728 <dd style="display: none; ">

729 <div></div>

730 </dd>

731

732 </div>

733 </div>

734 </dl>

735 </div>

736 </div>

737

738 <!-- MIN_VERSION -->

739 <p style="display: none; ">

740 This function was added in version <b><span></span></b>.

741 If you require this function, the manifest key

742 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>

743 can ensure that your extension won't be run in an earlier brow ser version.

744 </p>

745 </div> <!-- /description -->

746

747 </div> <!-- /apiItem -->

748

749 </div> <!-- /apiGroup -->

750

751 <!-- EVENTS -->

752 <div id="eventsTemplate" class="apiGroup" style="display: none; ">

753 <a></a>

754 <h3>Events</h3>

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

756 <div class="apiItem">

757 <a></a>

758 <h4>event name</h4>

759

760 <div class="summary">

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

762 <span class="subdued">chrome.bookmarks</span><span>onEvent</span ><span class="subdued">.addListener</span>(function(<span>Type param1, Type para m2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_p aram2</span>);

763 </div>

764

765 <div class="description">

766 <p class="todo">Undocumented.</p>

767 <p>

768 A description from the json schema def of the event goes here.

769 </p>

770

771 <!-- LISTENER PARAMETERS -->

772 <div>

773 <h4>Listener parameters</h4>

774 <dl>

775 <div>

776 <div>

777 </div>

778 </div>

779 </dl>

780 </div>

781

782 <!-- EXTRA PARAMETERS -->

783 <div>

784 <h4>Extra parameters to addListener</h4>

785 <dl>

786 <div>

787 <div>

788 </div>

789 </div>

790 </dl>

791 </div>

792

793 <!-- LISTENER RETURN VALUE -->

794 <h4>Listener returns</h4>

795 <dl>

796 <div>

797 <div>

798 </div>

799 </div>

800 </dl>

801

802 </div> <!-- /description -->

803 </div> <!-- /apiItem -->

804

805 </div> <!-- /apiGroup -->

806

807 <!-- TYPES -->

808 <div class="apiGroup" style="display: none; ">

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

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

811

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

813 <div class="apiItem">

814 <a></a>

815 <h4>type name</h4>

816

817 <div>

818 </div>

819

820 </div> <!-- /apiItem -->

821

822 </div> <!-- /apiGroup -->

823

824 </div> <!-- /apiPage -->

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

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

827 </div> <!-- /codesiteContent -->

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

829 <div class="text">

830 <p>

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

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

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

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

835 </p>

836 <p>

837 ©2011 Google

838 </p>

839

840 <!-- begin analytics -->

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

842 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>

843

844 <script type="text/javascript">

845 // chrome doc tracking

846 try {

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

848 engdocs._trackPageview();

849 } catch(err) {}

850

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

852 try {

853 _uacct="UA-18071-1";

854 _uanchor=1;

855 _uff=0;

856 urchinTracker();

857 }

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

859 </script>

860 <!-- end analytics -->

861 </div>

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

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

864 </body></html>

OLD	NEW