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

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

Issue 9617010: Move chrome.downloads out of experimental to dev (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
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 204 matching lines...) Expand 10 before | Expand all | Expand 10 after
215 <ol> 215 <ol>
216 <li> 216 <li>
217 <a href="#event-onAlarm">onAlarm</a> 217 <a href="#event-onAlarm">onAlarm</a>
218 </li> 218 </li>
219 </ol> 219 </ol>
220 </li> 220 </li>
221 <li> 221 <li>
222 <a href="#types">Types</a> 222 <a href="#types">Types</a>
223 <ol> 223 <ol>
224 <li> 224 <li>
225 <a href="#type-alarms.Alarm">alarms.Alarm</a> 225 <a href="#type-Alarm">Alarm</a>
226 <ol> 226 <ol>
227 </ol> 227 </ol>
228 </li><li> 228 </li><li>
229 <a href="#type-alarms.AlarmCreateInfo">alarms.AlarmCreateInfo</a > 229 <a href="#type-AlarmCreateInfo">AlarmCreateInfo</a>
230 <ol> 230 <ol>
231 </ol> 231 </ol>
232 </li> 232 </li>
233 </ol> 233 </ol>
234 </li> 234 </li>
235 </ol> 235 </ol>
236 </li> 236 </li>
237 </ol> 237 </ol>
238 </div> 238 </div>
239 <!-- /TABLE OF CONTENTS --> 239 <!-- /TABLE OF CONTENTS -->
(...skipping 82 matching lines...) Expand 10 before | Expand all | Expand 10 after
322 </dl> 322 </dl>
323 <!-- CALLBACK --> 323 <!-- CALLBACK -->
324 <!-- MIN_VERSION --> 324 <!-- MIN_VERSION -->
325 </div> <!-- /description --> 325 </div> <!-- /description -->
326 </div><div class="apiItem"> 326 </div><div class="apiItem">
327 <a name="method-create"></a> <!-- method-anchor --> 327 <a name="method-create"></a> <!-- method-anchor -->
328 <h4>create</h4> 328 <h4>create</h4>
329 <div class="summary"> 329 <div class="summary">
330 <!-- Note: intentionally longer 80 columns --> 330 <!-- Note: intentionally longer 80 columns -->
331 <span>chrome.alarms.create</span>(<span class="optional"><span >string</span> 331 <span>chrome.alarms.create</span>(<span class="optional"><span >string</span>
332 <var><span>name</span></var></span><span class="null"><spa n>, </span><span>alarms.AlarmCreateInfo</span> 332 <var><span>name</span></var></span><span class="null"><spa n>, </span><span>AlarmCreateInfo</span>
333 <var><span>alarmInfo</span></var></span>)</div> 333 <var><span>alarmInfo</span></var></span>)</div>
334 <div class="description"> 334 <div class="description">
335 <p>Creates an alarm. After the delay is elapsed, the onAlarm eve nt is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm. string.</p> 335 <p>Creates an alarm. After the delay is elapsed, the onAlarm eve nt is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm. string.</p>
336 <!-- PARAMETERS --> 336 <!-- PARAMETERS -->
337 <h4>Parameters</h4> 337 <h4>Parameters</h4>
338 <dl> 338 <dl>
339 <div> 339 <div>
340 <div> 340 <div>
341 <dt> 341 <dt>
342 <var>name</var> 342 <var>name</var>
(...skipping 20 matching lines...) Expand all
363 </div><div> 363 </div><div>
364 <div> 364 <div>
365 <dt> 365 <dt>
366 <var>alarmInfo</var> 366 <var>alarmInfo</var>
367 <em> 367 <em>
368 <!-- TYPE --> 368 <!-- TYPE -->
369 <div style="display:inline"> 369 <div style="display:inline">
370 ( 370 (
371 <span id="typeTemplate"> 371 <span id="typeTemplate">
372 <span> 372 <span>
373 <a href="alarms.html#type-alarms.AlarmCreateInfo">alarms .AlarmCreateInfo</a> 373 <a href="alarms.html#type-AlarmCreateInfo">AlarmCreateIn fo</a>
374 </span> 374 </span>
375 </span> 375 </span>
376 ) 376 )
377 </div> 377 </div>
378 </em> 378 </em>
379 </dt> 379 </dt>
380 <dd class="todo"> 380 <dd class="todo">
381 Undocumented. 381 Undocumented.
382 </dd> 382 </dd>
383 <!-- OBJECT PROPERTIES --> 383 <!-- OBJECT PROPERTIES -->
(...skipping 77 matching lines...) Expand 10 before | Expand all | Expand 10 after
461 <div> 461 <div>
462 <div> 462 <div>
463 <dt> 463 <dt>
464 <var>alarm</var> 464 <var>alarm</var>
465 <em> 465 <em>
466 <!-- TYPE --> 466 <!-- TYPE -->
467 <div style="display:inline"> 467 <div style="display:inline">
468 ( 468 (
469 <span id="typeTemplate"> 469 <span id="typeTemplate">
470 <span> 470 <span>
471 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 471 <a href="alarms.html#type-Alarm">Alarm</a>
472 </span> 472 </span>
473 </span> 473 </span>
474 ) 474 )
475 </div> 475 </div>
476 </em> 476 </em>
477 </dt> 477 </dt>
478 <dd class="todo"> 478 <dd class="todo">
479 Undocumented. 479 Undocumented.
480 </dd> 480 </dd>
481 <!-- OBJECT PROPERTIES --> 481 <!-- OBJECT PROPERTIES -->
(...skipping 13 matching lines...) Expand all
495 </dl> 495 </dl>
496 <!-- CALLBACK --> 496 <!-- CALLBACK -->
497 <div> 497 <div>
498 <div> 498 <div>
499 <h4>Callback function</h4> 499 <h4>Callback function</h4>
500 <p> 500 <p>
501 The callback <em>parameter</em> should specify a function 501 The callback <em>parameter</em> should specify a function
502 that looks like this: 502 that looks like this:
503 </p> 503 </p>
504 <!-- Note: intentionally longer 80 columns --> 504 <!-- Note: intentionally longer 80 columns -->
505 <pre>function(<span>alarms.Alarm alarm</span>) <span class="su bdued">{...}</span>;</pre> 505 <pre>function(<span>Alarm alarm</span>) <span class="subdued"> {...}</span>;</pre>
506 <dl> 506 <dl>
507 <div> 507 <div>
508 <div> 508 <div>
509 <dt> 509 <dt>
510 <var>alarm</var> 510 <var>alarm</var>
511 <em> 511 <em>
512 <!-- TYPE --> 512 <!-- TYPE -->
513 <div style="display:inline"> 513 <div style="display:inline">
514 ( 514 (
515 <span id="typeTemplate"> 515 <span id="typeTemplate">
516 <span> 516 <span>
517 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 517 <a href="alarms.html#type-Alarm">Alarm</a>
518 </span> 518 </span>
519 </span> 519 </span>
520 ) 520 )
521 </div> 521 </div>
522 </em> 522 </em>
523 </dt> 523 </dt>
524 <dd class="todo"> 524 <dd class="todo">
525 Undocumented. 525 Undocumented.
526 </dd> 526 </dd>
527 <!-- OBJECT PROPERTIES --> 527 <!-- OBJECT PROPERTIES -->
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after
581 <var>alarms</var> 581 <var>alarms</var>
582 <em> 582 <em>
583 <!-- TYPE --> 583 <!-- TYPE -->
584 <div style="display:inline"> 584 <div style="display:inline">
585 ( 585 (
586 <span id="typeTemplate"> 586 <span id="typeTemplate">
587 <span> 587 <span>
588 <span> 588 <span>
589 array of <span><span> 589 array of <span><span>
590 <span> 590 <span>
591 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 591 <a href="alarms.html#type-Alarm">Alarm</a>
592 </span> 592 </span>
593 </span></span> 593 </span></span>
594 </span> 594 </span>
595 </span> 595 </span>
596 </span> 596 </span>
597 ) 597 )
598 </div> 598 </div>
599 </em> 599 </em>
600 </dt> 600 </dt>
601 <dd class="todo"> 601 <dd class="todo">
(...skipping 16 matching lines...) Expand all
618 </dl> 618 </dl>
619 <!-- CALLBACK --> 619 <!-- CALLBACK -->
620 <div> 620 <div>
621 <div> 621 <div>
622 <h4>Callback function</h4> 622 <h4>Callback function</h4>
623 <p> 623 <p>
624 The callback <em>parameter</em> should specify a function 624 The callback <em>parameter</em> should specify a function
625 that looks like this: 625 that looks like this:
626 </p> 626 </p>
627 <!-- Note: intentionally longer 80 columns --> 627 <!-- Note: intentionally longer 80 columns -->
628 <pre>function(<span>array of alarms.Alarm alarms</span>) <span class="subdued">{...}</span>;</pre> 628 <pre>function(<span>array of Alarm alarms</span>) <span class= "subdued">{...}</span>;</pre>
629 <dl> 629 <dl>
630 <div> 630 <div>
631 <div> 631 <div>
632 <dt> 632 <dt>
633 <var>alarms</var> 633 <var>alarms</var>
634 <em> 634 <em>
635 <!-- TYPE --> 635 <!-- TYPE -->
636 <div style="display:inline"> 636 <div style="display:inline">
637 ( 637 (
638 <span id="typeTemplate"> 638 <span id="typeTemplate">
639 <span> 639 <span>
640 <span> 640 <span>
641 array of <span><span> 641 array of <span><span>
642 <span> 642 <span>
643 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 643 <a href="alarms.html#type-Alarm">Alarm</a>
644 </span> 644 </span>
645 </span></span> 645 </span></span>
646 </span> 646 </span>
647 </span> 647 </span>
648 </span> 648 </span>
649 ) 649 )
650 </div> 650 </div>
651 </em> 651 </em>
652 </dt> 652 </dt>
653 <dd class="todo"> 653 <dd class="todo">
(...skipping 15 matching lines...) Expand all
669 <!-- EVENTS --> 669 <!-- EVENTS -->
670 <div id="eventsTemplate" class="apiGroup"> 670 <div id="eventsTemplate" class="apiGroup">
671 <a name="global-events"></a> 671 <a name="global-events"></a>
672 <h3>Events</h3> 672 <h3>Events</h3>
673 <!-- iterates over all events --> 673 <!-- iterates over all events -->
674 <div class="apiItem"> 674 <div class="apiItem">
675 <a name="event-onAlarm"></a> 675 <a name="event-onAlarm"></a>
676 <h4>onAlarm</h4> 676 <h4>onAlarm</h4>
677 <div class="summary"> 677 <div class="summary">
678 <!-- Note: intentionally longer 80 columns --> 678 <!-- Note: intentionally longer 80 columns -->
679 <span class="subdued">chrome.alarms.</span><span>onAlarm</span>< span class="subdued">.addListener</span>(function(<span>alarms.Alarm alarm</span >) <span class="subdued">{...}</span><span></span>); 679 <span class="subdued">chrome.alarms.</span><span>onAlarm</span>< span class="subdued">.addListener</span>(function(<span>Alarm alarm</span>) <spa n class="subdued">{...}</span><span></span>);
680 </div> 680 </div>
681 <div class="description"> 681 <div class="description">
682 <p>Fired when an alarm has elapsed. Useful for transient backgro und pages.</p> 682 <p>Fired when an alarm has elapsed. Useful for transient backgro und pages.</p>
683 <!-- LISTENER PARAMETERS --> 683 <!-- LISTENER PARAMETERS -->
684 <div> 684 <div>
685 <h4>Listener parameters</h4> 685 <h4>Listener parameters</h4>
686 <dl> 686 <dl>
687 <div> 687 <div>
688 <div> 688 <div>
689 <dt> 689 <dt>
690 <var>alarm</var> 690 <var>alarm</var>
691 <em> 691 <em>
692 <!-- TYPE --> 692 <!-- TYPE -->
693 <div style="display:inline"> 693 <div style="display:inline">
694 ( 694 (
695 <span id="typeTemplate"> 695 <span id="typeTemplate">
696 <span> 696 <span>
697 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 697 <a href="alarms.html#type-Alarm">Alarm</a>
698 </span> 698 </span>
699 </span> 699 </span>
700 ) 700 )
701 </div> 701 </div>
702 </em> 702 </em>
703 </dt> 703 </dt>
704 <dd>The alarm that has elapsed.</dd> 704 <dd>The alarm that has elapsed.</dd>
705 <!-- OBJECT PROPERTIES --> 705 <!-- OBJECT PROPERTIES -->
706 <!-- OBJECT METHODS --> 706 <!-- OBJECT METHODS -->
707 <!-- OBJECT EVENT FIELDS --> 707 <!-- OBJECT EVENT FIELDS -->
708 <!-- FUNCTION PARAMETERS --> 708 <!-- FUNCTION PARAMETERS -->
709 </div> 709 </div>
710 </div> 710 </div>
711 </dl> 711 </dl>
712 </div> 712 </div>
713 <!-- EXTRA PARAMETERS --> 713 <!-- EXTRA PARAMETERS -->
714 <!-- LISTENER RETURN VALUE --> 714 <!-- LISTENER RETURN VALUE -->
715 <dl> 715 <dl>
716 </dl> 716 </dl>
717 </div> <!-- /description --> 717 </div> <!-- /description -->
718 <!-- /description --> 718 <!-- /description -->
719 </div> <!-- /apiItem --> 719 </div> <!-- /apiItem -->
720 </div> <!-- /apiGroup --> 720 </div> <!-- /apiGroup -->
721 <!-- TYPES --> 721 <!-- TYPES -->
722 <div class="apiGroup"> 722 <div class="apiGroup">
723 <a name="types"></a> 723 <a name="types"></a>
724 <h3 id="types">Types</h3> 724 <h3 id="types">Types</h3>
725 <!-- iterates over all types --> 725 <!-- iterates over all types -->
726 <div class="apiItem"> 726 <div class="apiItem">
727 <a name="type-alarms.Alarm"></a> 727 <a name="type-Alarm"></a>
728 <h4>alarms.Alarm</h4> 728 <h4>Alarm</h4>
729 <div> 729 <div>
730 <dt> 730 <dt>
731 <em> 731 <em>
732 <!-- TYPE --> 732 <!-- TYPE -->
733 <div style="display:inline"> 733 <div style="display:inline">
734 ( 734 (
735 <span id="typeTemplate"> 735 <span id="typeTemplate">
736 <span> 736 <span>
737 <span>object</span> 737 <span>object</span>
738 </span> 738 </span>
(...skipping 78 matching lines...) Expand 10 before | Expand all | Expand 10 after
817 <!-- FUNCTION PARAMETERS --> 817 <!-- FUNCTION PARAMETERS -->
818 </div> 818 </div>
819 </div> 819 </div>
820 </dl> 820 </dl>
821 </dd> 821 </dd>
822 <!-- OBJECT METHODS --> 822 <!-- OBJECT METHODS -->
823 <!-- OBJECT EVENT FIELDS --> 823 <!-- OBJECT EVENT FIELDS -->
824 <!-- FUNCTION PARAMETERS --> 824 <!-- FUNCTION PARAMETERS -->
825 </div> 825 </div>
826 </div><div class="apiItem"> 826 </div><div class="apiItem">
827 <a name="type-alarms.AlarmCreateInfo"></a> 827 <a name="type-AlarmCreateInfo"></a>
828 <h4>alarms.AlarmCreateInfo</h4> 828 <h4>AlarmCreateInfo</h4>
829 <div> 829 <div>
830 <dt> 830 <dt>
831 <em> 831 <em>
832 <!-- TYPE --> 832 <!-- TYPE -->
833 <div style="display:inline"> 833 <div style="display:inline">
834 ( 834 (
835 <span id="typeTemplate"> 835 <span id="typeTemplate">
836 <span> 836 <span>
837 <span>object</span> 837 <span>object</span>
838 </span> 838 </span>
(...skipping 95 matching lines...) Expand 10 before | Expand all | Expand 10 after
934 _uff=0; 934 _uff=0;
935 urchinTracker(); 935 urchinTracker();
936 } 936 }
937 catch(e) {/* urchinTracker not available. */} 937 catch(e) {/* urchinTracker not available. */}
938 </script> 938 </script>
939 <!-- end analytics --> 939 <!-- end analytics -->
940 </div> 940 </div>
941 </div> <!-- /gc-footer --> 941 </div> <!-- /gc-footer -->
942 </div> <!-- /gc-container --> 942 </div> <!-- /gc-container -->
943 </body></html> 943 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698