Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(654)

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10810074: Updates to documentation for experimental.apps (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: rebased Created 8 years, 4 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
« no previous file with comments | « chrome/common/extensions/api/experimental_app.json ('k') | chrome/common/extensions/docs/extensions/experimental.app.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 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 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 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 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 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 149 matching lines...) Expand 10 before | Expand all | Expand 10 after
160 <h1 class="page_title">Experimental App APIs</h1> 160 <h1 class="page_title">Experimental App APIs</h1>
161 </div> 161 </div>
162 <!-- TABLE OF CONTENTS --> 162 <!-- TABLE OF CONTENTS -->
163 <div id="toc"> 163 <div id="toc">
164 <h2>Contents</h2> 164 <h2>Contents</h2>
165 <ol> 165 <ol>
166 <li> 166 <li>
167 <a href="#apiReference">API reference: chrome.experimental.app</ a> 167 <a href="#apiReference">API reference: chrome.experimental.app</ a>
168 <ol> 168 <ol>
169 <li> 169 <li>
170 <a href="#global-methods">Methods</a> 170 <a href="#global-events">Events</a>
171 <ol> 171 <ol>
172 <li> 172 <li>
173 <a href="#method-clearAllNotifications">clearAllNotifications</a > 173 <a href="#event-onLaunched">onLaunched</a>
174 </li><li>
175 <a href="#method-notify">notify</a>
176 </li> 174 </li>
177 </ol> 175 </ol>
178 </li> 176 </li>
179 </ol> 177 </ol>
180 </li> 178 </li>
181 </ol> 179 </ol>
182 </div> 180 </div>
183 <!-- /TABLE OF CONTENTS --> 181 <!-- /TABLE OF CONTENTS -->
184 <!-- Standard content lead-in for experimental API pages --> 182 <!-- Standard content lead-in for experimental API pages -->
185 <!-- STATIC CONTENT PLACEHOLDER --> 183 <!-- STATIC CONTENT PLACEHOLDER -->
186 <div id="static"><div id="pageData-name" class="pageData">Experimental A pp APIs</div> 184 <div id="static"><div id="pageData-name" class="pageData">Experimental A pp APIs</div>
187 <!-- BEGIN AUTHORED CONTENT --> 185 <!-- BEGIN AUTHORED CONTENT -->
188 <p>The current methods allow applications to generate passive notifications.</p> 186 <p>The current methods allow applications to generate passive notifications.</p>
189 <!-- END AUTHORED CONTENT --> 187 <!-- END AUTHORED CONTENT -->
190 </div> 188 </div>
191 <!-- API PAGE --> 189 <!-- API PAGE -->
192 <div class="apiPage"> 190 <div class="apiPage">
193 <a name="apiReference"></a> 191 <a name="apiReference"></a>
194 <h2>API reference: chrome.experimental.app</h2> 192 <h2>API reference: chrome.experimental.app</h2>
195 <!-- PROPERTIES --> 193 <!-- PROPERTIES -->
196 <!-- /apiGroup --> 194 <!-- /apiGroup -->
197 <!-- METHODS --> 195 <!-- METHODS -->
198 <div id="methodsTemplate" class="apiGroup"> 196 <!-- /apiGroup -->
199 <a name="global-methods"></a> 197 <!-- EVENTS -->
200 <h3>Methods</h3> 198 <div id="eventsTemplate" class="apiGroup">
201 <!-- iterates over all functions --> 199 <a name="global-events"></a>
200 <h3>Events</h3>
201 <!-- iterates over all events -->
202 <div class="apiItem"> 202 <div class="apiItem">
203 <a name="method-clearAllNotifications"></a> <!-- method-anchor --> 203 <a name="event-onLaunched"></a>
204 <h4>clearAllNotifications</h4> 204 <h4>onLaunched</h4>
205 <div class="summary"> 205 <div class="summary">
206 <!-- Note: intentionally longer 80 columns --> 206 <!-- Note: intentionally longer 80 columns -->
207 <span>chrome.experimental.app.clearAllNotifications</span>(<sp an class="optional"><span>object</span> 207 <span class="subdued">chrome.experimental.app.</span><span>onLau nched</span><span class="subdued">.addListener</span>(function(<span>object laun chData</span>) <span class="subdued">{...}</span><span></span>);
208 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span> 208 </div>
209 <var><span>callback</span></var></span>)</div>
210 <div class="description"> 209 <div class="description">
211 <p>Clears all previously sent notifications.</p> 210 <p>Fired when the app is launched.</p>
212 <!-- PARAMETERS --> 211 <!-- LISTENER PARAMETERS -->
213 <h4>Parameters</h4> 212 <div>
214 <dl> 213 <h4>Listener parameters</h4>
215 <div> 214 <dl>
216 <div> 215 <div>
216 <div>
217 <dt> 217 <dt>
218 <var>details</var> 218 <var>launchData</var>
219 <em> 219 <em>
220 <!-- TYPE --> 220 <!-- TYPE -->
221 <div style="display:inline"> 221 <div style="display:inline">
222 ( 222 (
223 <span class="optional">optional</span> 223 <span class="optional">optional</span>
224 <span id="typeTemplate"> 224 <span id="typeTemplate">
225 <span> 225 <span>
226 <span>object</span> 226 <span>object</span>
227 </span> 227 </span>
228 </span> 228 </span>
229 ) 229 )
230 </div> 230 </div>
231 </em> 231 </em>
232 </dt> 232 </dt>
233 <dd class="todo"> 233 <dd>Optional data for the launch.</dd>
234 Undocumented.
235 </dd>
236 <!-- OBJECT PROPERTIES --> 234 <!-- OBJECT PROPERTIES -->
237 <dd> 235 <dd>
238 <dl> 236 <dl>
239 <div> 237 <div>
240 <div> 238 <div>
241 <dt> 239 <dt>
242 <var>extensionId</var> 240 <var>intent</var>
243 <em> 241 <em>
244 <!-- TYPE --> 242 <!-- TYPE -->
245 <div style="display:inline"> 243 <div style="display:inline">
246 (
247 <span class="optional">optional</span>
248 <span id="typeTemplate">
249 <span>
250 <span>string</span>
251 </span>
252 </span>
253 )
254 </div>
255 </em>
256 </dt>
257 <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>
258 <!-- OBJECT PROPERTIES -->
259 <!-- OBJECT METHODS -->
260 <!-- OBJECT EVENT FIELDS -->
261 <!-- FUNCTION PARAMETERS -->
262 </div>
263 </div>
264 </dl>
265 </dd>
266 <!-- OBJECT METHODS -->
267 <!-- OBJECT EVENT FIELDS -->
268 <!-- FUNCTION PARAMETERS -->
269 </div>
270 </div><div>
271 <div>
272 <dt>
273 <var>callback</var>
274 <em>
275 <!-- TYPE -->
276 <div style="display:inline">
277 (
278 <span class="optional">optional</span>
279 <span id="typeTemplate">
280 <span>
281 <span>function</span>
282 </span>
283 </span>
284 )
285 </div>
286 </em>
287 </dt>
288 <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>
289 <!-- OBJECT PROPERTIES -->
290 <!-- OBJECT METHODS -->
291 <!-- OBJECT EVENT FIELDS -->
292 <!-- FUNCTION PARAMETERS -->
293 </div>
294 </div>
295 </dl>
296 <!-- RETURNS -->
297 <dl>
298 </dl>
299 <!-- CALLBACK -->
300 <!-- MIN_VERSION -->
301 </div> <!-- /description -->
302 </div><div class="apiItem">
303 <a name="method-notify"></a> <!-- method-anchor -->
304 <h4>notify</h4>
305 <div class="summary">
306 <!-- Note: intentionally longer 80 columns -->
307 <span>chrome.experimental.app.notify</span>(<span class="null" ><span>object</span>
308 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
309 <var><span>callback</span></var></span>)</div>
310 <div class="description">
311 <p>Creates a notification from this app.</p>
312 <!-- PARAMETERS -->
313 <h4>Parameters</h4>
314 <dl>
315 <div>
316 <div>
317 <dt>
318 <var>details</var>
319 <em>
320 <!-- TYPE -->
321 <div style="display:inline">
322 ( 244 (
323 <span id="typeTemplate"> 245 <span id="typeTemplate">
324 <span> 246 <span>
325 <span>object</span> 247 <span>object</span>
326 </span> 248 </span>
327 </span> 249 </span>
328 ) 250 )
329 </div> 251 </div>
330 </em> 252 </em>
331 </dt> 253 </dt>
332 <dd class="todo"> 254 <dd>A WebIntents intent object.</dd>
333 Undocumented.
334 </dd>
335 <!-- OBJECT PROPERTIES --> 255 <!-- OBJECT PROPERTIES -->
336 <dd> 256 <dd>
337 <dl> 257 <dl>
338 <div> 258 <div>
339 <div> 259 <div>
340 <dt> 260 <dt>
341 <var>extensionId</var> 261 <var>action</var>
342 <em> 262 <em>
343 <!-- TYPE --> 263 <!-- TYPE -->
344 <div style="display:inline"> 264 <div style="display:inline">
345 ( 265 (
346 <span class="optional">optional</span>
347 <span id="typeTemplate"> 266 <span id="typeTemplate">
348 <span> 267 <span>
349 <span>string</span> 268 <span>string</span>
350 </span> 269 </span>
351 </span> 270 </span>
352 ) 271 )
353 </div> 272 </div>
354 </em> 273 </em>
355 </dt> 274 </dt>
356 <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> 275 <dd>The WebIntent being invoked.</dd>
357 <!-- OBJECT PROPERTIES --> 276 <!-- OBJECT PROPERTIES -->
358 <!-- OBJECT METHODS --> 277 <!-- OBJECT METHODS -->
359 <!-- OBJECT EVENT FIELDS --> 278 <!-- OBJECT EVENT FIELDS -->
360 <!-- FUNCTION PARAMETERS --> 279 <!-- FUNCTION PARAMETERS -->
361 </div> 280 </div>
362 </div><div> 281 </div><div>
363 <div> 282 <div>
364 <dt> 283 <dt>
365 <var>title</var> 284 <var>type</var>
366 <em> 285 <em>
367 <!-- TYPE --> 286 <!-- TYPE -->
368 <div style="display:inline"> 287 <div style="display:inline">
369 ( 288 (
370 <span class="optional">optional</span>
371 <span id="typeTemplate"> 289 <span id="typeTemplate">
372 <span> 290 <span>
373 <span>string</span> 291 <span>string</span>
374 </span> 292 </span>
375 </span> 293 </span>
376 ) 294 )
377 </div> 295 </div>
378 </em> 296 </em>
379 </dt> 297 </dt>
380 <dd>The title of the notification.</dd> 298 <dd>The MIME type of the data.</dd>
381 <!-- OBJECT PROPERTIES --> 299 <!-- OBJECT PROPERTIES -->
382 <!-- OBJECT METHODS --> 300 <!-- OBJECT METHODS -->
383 <!-- OBJECT EVENT FIELDS --> 301 <!-- OBJECT EVENT FIELDS -->
384 <!-- FUNCTION PARAMETERS --> 302 <!-- FUNCTION PARAMETERS -->
385 </div> 303 </div>
386 </div><div> 304 </div><div>
387 <div> 305 <div>
388 <dt> 306 <dt>
389 <var>bodyText</var> 307 <var>data</var>
390 <em> 308 <em>
391 <!-- TYPE --> 309 <!-- TYPE -->
392 <div style="display:inline"> 310 <div style="display:inline">
393 ( 311 (
394 <span class="optional">optional</span>
395 <span id="typeTemplate"> 312 <span id="typeTemplate">
396 <span> 313 <span>
397 <span>string</span> 314 <span>any</span>
398 </span> 315 </span>
399 </span> 316 </span>
400 ) 317 )
401 </div> 318 </div>
402 </em> 319 </em>
403 </dt> 320 </dt>
404 <dd>The text content of the notification.</dd> 321 <dd>Data associated with the intent.</dd>
405 <!-- OBJECT PROPERTIES --> 322 <!-- OBJECT PROPERTIES -->
406 <!-- OBJECT METHODS --> 323 <!-- OBJECT METHODS -->
407 <!-- OBJECT EVENT FIELDS --> 324 <!-- OBJECT EVENT FIELDS -->
408 <!-- FUNCTION PARAMETERS --> 325 <!-- FUNCTION PARAMETERS -->
409 </div> 326 </div>
410 </div><div> 327 </div><div>
411 <div> 328 <div>
412 <dt> 329 <dt>
413 <var>linkUrl</var> 330 <var>postResult</var>
414 <em> 331 <em>
415 <!-- TYPE --> 332 <!-- TYPE -->
416 <div style="display:inline"> 333 <div style="display:inline">
417 ( 334 (
418 <span class="optional">optional</span>
419 <span id="typeTemplate"> 335 <span id="typeTemplate">
420 <span> 336 <span>
421 <span>string</span> 337 <span>function</span>
422 </span> 338 </span>
423 </span> 339 </span>
424 ) 340 )
425 </div> 341 </div>
426 </em> 342 </em>
427 </dt> 343 </dt>
428 <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> 344 <dd>Null callback to be compatible with WebIntents.</dd>
429 <!-- OBJECT PROPERTIES --> 345 <!-- OBJECT PROPERTIES -->
430 <!-- OBJECT METHODS --> 346 <!-- OBJECT METHODS -->
431 <!-- OBJECT EVENT FIELDS --> 347 <!-- OBJECT EVENT FIELDS -->
432 <!-- FUNCTION PARAMETERS --> 348 <!-- FUNCTION PARAMETERS -->
433 </div> 349 </div>
434 </div><div> 350 </div><div>
435 <div> 351 <div>
436 <dt> 352 <dt>
437 <var>linkText</var> 353 <var>postFailure</var>
438 <em> 354 <em>
439 <!-- TYPE --> 355 <!-- TYPE -->
440 <div style="display:inline"> 356 <div style="display:inline">
441 ( 357 (
442 <span class="optional">optional</span>
443 <span id="typeTemplate"> 358 <span id="typeTemplate">
444 <span> 359 <span>
445 <span>string</span> 360 <span>function</span>
446 </span> 361 </span>
447 </span> 362 </span>
448 ) 363 )
449 </div> 364 </div>
450 </em> 365 </em>
451 </dt> 366 </dt>
452 <dd>If a linkUrl is provided, this is required and will be used as the linkified text. It should be relatively short.</dd> 367 <dd>Null callback to be compatible with WebIntents.</dd>
453 <!-- OBJECT PROPERTIES --> 368 <!-- OBJECT PROPERTIES -->
454 <!-- OBJECT METHODS --> 369 <!-- OBJECT METHODS -->
455 <!-- OBJECT EVENT FIELDS --> 370 <!-- OBJECT EVENT FIELDS -->
456 <!-- FUNCTION PARAMETERS --> 371 <!-- FUNCTION PARAMETERS -->
457 </div> 372 </div>
458 </div> 373 </div>
459 </dl> 374 </dl>
460 </dd> 375 </dd>
461 <!-- OBJECT METHODS --> 376 <!-- OBJECT METHODS -->
462 <!-- OBJECT EVENT FIELDS --> 377 <!-- OBJECT EVENT FIELDS -->
463 <!-- FUNCTION PARAMETERS --> 378 <!-- FUNCTION PARAMETERS -->
464 </div> 379 </div>
465 </div><div> 380 </div>
466 <div> 381 </dl>
467 <dt> 382 </dd>
468 <var>callback</var>
469 <em>
470 <!-- TYPE -->
471 <div style="display:inline">
472 (
473 <span class="optional">optional</span>
474 <span id="typeTemplate">
475 <span>
476 <span>function</span>
477 </span>
478 </span>
479 )
480 </div>
481 </em>
482 </dt>
483 <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>
484 <!-- OBJECT PROPERTIES -->
485 <!-- OBJECT METHODS --> 383 <!-- OBJECT METHODS -->
486 <!-- OBJECT EVENT FIELDS --> 384 <!-- OBJECT EVENT FIELDS -->
487 <!-- FUNCTION PARAMETERS --> 385 <!-- FUNCTION PARAMETERS -->
488 </div> 386 </div>
489 </div> 387 </div>
490 </dl> 388 </dl>
491 <!-- RETURNS --> 389 </div>
390 <!-- EXTRA PARAMETERS -->
391 <!-- LISTENER RETURN VALUE -->
492 <dl> 392 <dl>
493 </dl> 393 </dl>
494 <!-- CALLBACK -->
495 <!-- MIN_VERSION -->
496 </div> <!-- /description --> 394 </div> <!-- /description -->
497 </div> <!-- /apiItem --> 395 <!-- /description -->
498 </div> <!-- /apiGroup --> 396 </div> <!-- /apiItem -->
499 <!-- EVENTS --> 397 </div> <!-- /apiGroup -->
500 <!-- /apiGroup -->
501 <!-- TYPES --> 398 <!-- TYPES -->
502 <!-- /apiGroup --> 399 <!-- /apiGroup -->
503 </div> <!-- /apiPage --> 400 </div> <!-- /apiPage -->
504 </div> <!-- /gc-pagecontent --> 401 </div> <!-- /gc-pagecontent -->
505 </div> <!-- /g-section --> 402 </div> <!-- /g-section -->
506 </div> <!-- /codesiteContent --> 403 </div> <!-- /codesiteContent -->
507 <div id="gc-footer" --=""> 404 <div id="gc-footer" --="">
508 <div class="text"> 405 <div class="text">
509 <p> 406 <p>
510 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>, 407 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
(...skipping 29 matching lines...) Expand all
540 _uff=0; 437 _uff=0;
541 urchinTracker(); 438 urchinTracker();
542 } 439 }
543 catch(e) {/* urchinTracker not available. */} 440 catch(e) {/* urchinTracker not available. */}
544 </script> 441 </script>
545 <!-- end analytics --> 442 <!-- end analytics -->
546 </div> 443 </div>
547 </div> <!-- /gc-footer --> 444 </div> <!-- /gc-footer -->
548 </div> <!-- /gc-container --> 445 </div> <!-- /gc-container -->
549 </body></html> 446 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/experimental_app.json ('k') | chrome/common/extensions/docs/extensions/experimental.app.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698