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

Side by Side Diff: chrome/common/extensions/docs/experimental.app.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.experimental.ap p module, which is part of the Google Chrome extension APIs."><title>Experiment al App APIs - Google Chrome Extensions - 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><a href="tabs.html">Tabs</a></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">Experimental App APIs</h1>

189 </div>

190 <!-- TABLE OF CONTENTS -->

191 <div id="toc">

192 <h2>Contents</h2>

193 <ol>

194 <li>

195 <a href="#apiReference">API reference: chrome.experimental.app</ a>

196 <ol>

197 <li>

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

199 <ol>

200 <li>

201 <a href="#method-clearAllNotifications">clearAllNotifications</a >

202 </li><li>

203 <a href="#method-notify">notify</a>

204 </li>

205 </ol>

206 </li>

207 </ol>

208 </li>

209 </ol>

210 </div>

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

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

213 <!-- STATIC CONTENT PLACEHOLDER -->

214 <div id="static"><div id="pageData-name" class="pageData">Experimental A pp APIs</div>

215 <!-- BEGIN AUTHORED CONTENT -->

216 <p>The current methods allow applications to generate passive notifications.</p>

217 <!-- END AUTHORED CONTENT -->

218 </div>

219 <!-- API PAGE -->

220 <div class="apiPage">

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

222 <h2>API reference: chrome.experimental.app</h2>

223 <!-- PROPERTIES -->

224 <!-- /apiGroup -->

225 <!-- METHODS -->

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

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

228 <h3>Methods</h3>

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

230 <div class="apiItem">

231 <a name="method-clearAllNotifications"></a> <!-- method-anchor -->

232 <h4>clearAllNotifications</h4>

233 <div class="summary">

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

235 <span>chrome.experimental.app.clearAllNotifications</span>(<sp an class="optional"><span>object</span>

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

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

238 <div class="description">

239 <p>Clears all previously sent notifications.</p>

240 <!-- PARAMETERS -->

241 <h4>Parameters</h4>

242 <dl>

243 <div>

244 <div>

245 <dt>

246 <var>details</var>

247 <em>

248 <!-- TYPE -->

249 <div style="display:inline">

250 (

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

252 <span id="typeTemplate">

253 <span>

254 <span>object</span>

255 </span>

256 </span>

257 )

258 </div>

259 </em>

260 </dt>

261 <dd class="todo">

262 Undocumented.

263 </dd>

264 <!-- OBJECT PROPERTIES -->

265 <dd>

266 <dl>

267 <div>

268 <div>

269 <dt>

270 <var>extensionId</var>

271 <em>

272 <!-- TYPE -->

273 <div style="display:inline">

274 (

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

276 <span id="typeTemplate">

277 <span>

278 <span>string</span>

279 </span>

280 </span>

281 )

282 </div>

283 </em>

284 </dt>

285 <dd>An optional id to do notifications for an app other than the calli ng app. This is just to allow prototyping with an extension that sends notificat ions on behalf of apps that don't support notifications yet; this will be remove d before the API becomes stable.</dd>

286 <!-- OBJECT PROPERTIES -->

287 <!-- OBJECT METHODS -->

288 <!-- OBJECT EVENT FIELDS -->

289 <!-- FUNCTION PARAMETERS -->

290 </div>

291 </div>

292 </dl>

293 </dd>

294 <!-- OBJECT METHODS -->

295 <!-- OBJECT EVENT FIELDS -->

296 <!-- FUNCTION PARAMETERS -->

297 </div>

298 </div><div>

299 <div>

300 <dt>

301 <var>callback</var>

302 <em>

303 <!-- TYPE -->

304 <div style="display:inline">

305 (

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

307 <span id="typeTemplate">

308 <span>

309 <span>function</span>

310 </span>

311 </span>

312 )

313 </div>

314 </em>

315 </dt>

316 <dd>A callback when the function is complete. Any errors will be repor ted in <a href="extension.html#property-lastError">chrome.extension.lastError</a >.</dd>

317 <!-- OBJECT PROPERTIES -->

318 <!-- OBJECT METHODS -->

319 <!-- OBJECT EVENT FIELDS -->

320 <!-- FUNCTION PARAMETERS -->

321 </div>

322 </div>

323 </dl>

324 <!-- RETURNS -->

325 <dl>

326 </dl>

327 <!-- CALLBACK -->

328 <div>

329 <div>

330 <h4>Callback function</h4>

331 <p>

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

333 specify a function that looks like this:

334 </p>

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

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

337 <dl>

338 </dl>

339 </div>

340 </div>

341 <!-- MIN_VERSION -->

342 </div> <!-- /description -->

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

344 <a name="method-notify"></a> <!-- method-anchor -->

345 <h4>notify</h4>

346 <div class="summary">

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

348 <span>chrome.experimental.app.notify</span>(<span class="null" ><span>object</span>

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

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

351 <div class="description">

352 <p>Creates a notification from this app.</p>

353 <!-- PARAMETERS -->

354 <h4>Parameters</h4>

355 <dl>

356 <div>

357 <div>

358 <dt>

359 <var>details</var>

360 <em>

361 <!-- TYPE -->

362 <div style="display:inline">

363 (

364 <span id="typeTemplate">

365 <span>

366 <span>object</span>

367 </span>

368 </span>

369 )

370 </div>

371 </em>

372 </dt>

373 <dd class="todo">

374 Undocumented.

375 </dd>

376 <!-- OBJECT PROPERTIES -->

377 <dd>

378 <dl>

379 <div>

380 <div>

381 <dt>

382 <var>extensionId</var>

383 <em>

384 <!-- TYPE -->

385 <div style="display:inline">

386 (

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

388 <span id="typeTemplate">

389 <span>

390 <span>string</span>

391 </span>

392 </span>

393 )

394 </div>

395 </em>

396 </dt>

397 <dd>An optional id to do notifications for an app other than the calli ng app. This is just to allow prototyping with an extension that sends notificat ions on behalf of apps that don't support notifications yet; this will be remove d before the API becomes stable.</dd>

398 <!-- OBJECT PROPERTIES -->

399 <!-- OBJECT METHODS -->

400 <!-- OBJECT EVENT FIELDS -->

401 <!-- FUNCTION PARAMETERS -->

402 </div>

403 </div><div>

404 <div>

405 <dt>

406 <var>title</var>

407 <em>

408 <!-- TYPE -->

409 <div style="display:inline">

410 (

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

412 <span id="typeTemplate">

413 <span>

414 <span>string</span>

415 </span>

416 </span>

417 )

418 </div>

419 </em>

420 </dt>

421 <dd>The title of the notification.</dd>

422 <!-- OBJECT PROPERTIES -->

423 <!-- OBJECT METHODS -->

424 <!-- OBJECT EVENT FIELDS -->

425 <!-- FUNCTION PARAMETERS -->

426 </div>

427 </div><div>

428 <div>

429 <dt>

430 <var>bodyText</var>

431 <em>

432 <!-- TYPE -->

433 <div style="display:inline">

434 (

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

436 <span id="typeTemplate">

437 <span>

438 <span>string</span>

439 </span>

440 </span>

441 )

442 </div>

443 </em>

444 </dt>

445 <dd>The text content of the notification.</dd>

446 <!-- OBJECT PROPERTIES -->

447 <!-- OBJECT METHODS -->

448 <!-- OBJECT EVENT FIELDS -->

449 <!-- FUNCTION PARAMETERS -->

450 </div>

451 </div><div>

452 <div>

453 <dt>

454 <var>linkUrl</var>

455 <em>

456 <!-- TYPE -->

457 <div style="display:inline">

458 (

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

460 <span id="typeTemplate">

461 <span>

462 <span>string</span>

463 </span>

464 </span>

465 )

466 </div>

467 </em>

468 </dt>

469 <dd>The URL for an optional link to show along with the notification. If you specify a linkUrl, you must also specify a value for linkText.</dd>

470 <!-- OBJECT PROPERTIES -->

471 <!-- OBJECT METHODS -->

472 <!-- OBJECT EVENT FIELDS -->

473 <!-- FUNCTION PARAMETERS -->

474 </div>

475 </div><div>

476 <div>

477 <dt>

478 <var>linkText</var>

479 <em>

480 <!-- TYPE -->

481 <div style="display:inline">

482 (

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

484 <span id="typeTemplate">

485 <span>

486 <span>string</span>

487 </span>

488 </span>

489 )

490 </div>

491 </em>

492 </dt>

493 <dd>If a linkUrl is provided, this is required and will be used as the linkified text. It should be relatively short.</dd>

494 <!-- OBJECT PROPERTIES -->

495 <!-- OBJECT METHODS -->

496 <!-- OBJECT EVENT FIELDS -->

497 <!-- FUNCTION PARAMETERS -->

498 </div>

499 </div>

500 </dl>

501 </dd>

502 <!-- OBJECT METHODS -->

503 <!-- OBJECT EVENT FIELDS -->

504 <!-- FUNCTION PARAMETERS -->

505 </div>

506 </div><div>

507 <div>

508 <dt>

509 <var>callback</var>

510 <em>

511 <!-- TYPE -->

512 <div style="display:inline">

513 (

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

515 <span id="typeTemplate">

516 <span>

517 <span>function</span>

518 </span>

519 </span>

520 )

521 </div>

522 </em>

523 </dt>

524 <dd>A callback when the function is complete. Any errors will be repor ted in <a href="extension.html#property-lastError">chrome.extension.lastError</a >.</dd>

525 <!-- OBJECT PROPERTIES -->

526 <!-- OBJECT METHODS -->

527 <!-- OBJECT EVENT FIELDS -->

528 <!-- FUNCTION PARAMETERS -->

529 </div>

530 </div>

531 </dl>

532 <!-- RETURNS -->

533 <dl>

534 </dl>

535 <!-- CALLBACK -->

536 <div>

537 <div>

538 <h4>Callback function</h4>

539 <p>

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

541 specify a function that looks like this:

542 </p>

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

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

545 <dl>

546 </dl>

547 </div>

548 </div>

549 <!-- MIN_VERSION -->

550 </div> <!-- /description -->

551 </div> <!-- /apiItem -->

552 </div> <!-- /apiGroup -->

553 <!-- EVENTS -->

554 <!-- /apiGroup -->

555 <!-- TYPES -->

556 <!-- /apiGroup -->

557 </div> <!-- /apiPage -->

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

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

560 </div> <!-- /codesiteContent -->

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

562 <div class="text">

563 <p>

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

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

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

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

568 </p>

569 <p>

570 ©2011 Google

571 </p>

572 <!-- begin analytics -->

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

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

575 <script type="text/javascript">

576 // chrome doc tracking

577 try {

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

579 engdocs._trackPageview();

580 } catch(err) {}

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

582 try {

583 _uacct="UA-18071-1";

584 _uanchor=1;

585 _uff=0;

586 urchinTracker();

587 }

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

589 </script>

590 <!-- end analytics -->

591 </div>

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

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

594 </body></html>

OLD	NEW