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

Issues Search
    My Issues | Starred     Open | Closed | All

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: merge 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
« no previous file with comments | « chrome/common/extensions/api/extension_api.cc ('k') | chrome/common/extensions/docs/api_index.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 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. Near the time(s) specified by <var>alarmIn fo</var>, the <code>onAlarm</code> event is fired. If there is another alarm wit h the same name (or no name if none is specified), it will be cancelled and repl aced by this alarm. Note that granularity is not guaranteed: times are more of a hint to the browser. For performance reasons, alarms may be delayed an arbitrar y amount of time before firing.</p> 335 <p>Creates an alarm. Near the time(s) specified by <var>alarmIn fo</var>, the <code>onAlarm</code> event is fired. If there is another alarm wit h the same name (or no name if none is specified), it will be cancelled and repl aced by this alarm. Note that granularity is not guaranteed: times are more of a hint to the browser. For performance reasons, alarms may be delayed an arbitrar y amount of time before firing.</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>Describes when the alarm should fire. The initial time must be sp ecified by either <var>when</var> or <var>delayInMinutes</var> (but not both). If <var>periodInMinutes</var> is set, the alarm will repeat every <var>periodInM inutes</var> minutes after the initial event. If neither <var>when</var> or <va r>delayInMinutes</var> is set for a repeating alarm, <var>periodInMinutes</var> is used as the default for <var>delayInMinutes</var>.</dd> 380 <dd>Describes when the alarm should fire. The initial time must be sp ecified by either <var>when</var> or <var>delayInMinutes</var> (but not both). If <var>periodInMinutes</var> is set, the alarm will repeat every <var>periodInM inutes</var> minutes after the initial event. If neither <var>when</var> or <va r>delayInMinutes</var> is set for a repeating alarm, <var>periodInMinutes</var> is used as the default for <var>delayInMinutes</var>.</dd>
381 <!-- OBJECT PROPERTIES --> 381 <!-- OBJECT PROPERTIES -->
382 <!-- OBJECT METHODS --> 382 <!-- OBJECT METHODS -->
383 <!-- OBJECT EVENT FIELDS --> 383 <!-- OBJECT EVENT FIELDS -->
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after
459 <div> 459 <div>
460 <div> 460 <div>
461 <dt> 461 <dt>
462 <var>alarm</var> 462 <var>alarm</var>
463 <em> 463 <em>
464 <!-- TYPE --> 464 <!-- TYPE -->
465 <div style="display:inline"> 465 <div style="display:inline">
466 ( 466 (
467 <span id="typeTemplate"> 467 <span id="typeTemplate">
468 <span> 468 <span>
469 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 469 <a href="alarms.html#type-Alarm">Alarm</a>
470 </span> 470 </span>
471 </span> 471 </span>
472 ) 472 )
473 </div> 473 </div>
474 </em> 474 </em>
475 </dt> 475 </dt>
476 <dd class="todo"> 476 <dd class="todo">
477 Undocumented. 477 Undocumented.
478 </dd> 478 </dd>
479 <!-- OBJECT PROPERTIES --> 479 <!-- OBJECT PROPERTIES -->
(...skipping 13 matching lines...) Expand all
493 </dl> 493 </dl>
494 <!-- CALLBACK --> 494 <!-- CALLBACK -->
495 <div> 495 <div>
496 <div> 496 <div>
497 <h4>Callback function</h4> 497 <h4>Callback function</h4>
498 <p> 498 <p>
499 The <em>callback</em> parameter should specify a function 499 The <em>callback</em> parameter should specify a function
500 that looks like this: 500 that looks like this:
501 </p> 501 </p>
502 <!-- Note: intentionally longer 80 columns --> 502 <!-- Note: intentionally longer 80 columns -->
503 <pre>function(<span>alarms.Alarm alarm</span>) <span class="su bdued">{...}</span>;</pre> 503 <pre>function(<span>Alarm alarm</span>) <span class="subdued"> {...}</span>;</pre>
504 <dl> 504 <dl>
505 <div> 505 <div>
506 <div> 506 <div>
507 <dt> 507 <dt>
508 <var>alarm</var> 508 <var>alarm</var>
509 <em> 509 <em>
510 <!-- TYPE --> 510 <!-- TYPE -->
511 <div style="display:inline"> 511 <div style="display:inline">
512 ( 512 (
513 <span id="typeTemplate"> 513 <span id="typeTemplate">
514 <span> 514 <span>
515 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 515 <a href="alarms.html#type-Alarm">Alarm</a>
516 </span> 516 </span>
517 </span> 517 </span>
518 ) 518 )
519 </div> 519 </div>
520 </em> 520 </em>
521 </dt> 521 </dt>
522 <dd class="todo"> 522 <dd class="todo">
523 Undocumented. 523 Undocumented.
524 </dd> 524 </dd>
525 <!-- OBJECT PROPERTIES --> 525 <!-- OBJECT PROPERTIES -->
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after
579 <var>alarms</var> 579 <var>alarms</var>
580 <em> 580 <em>
581 <!-- TYPE --> 581 <!-- TYPE -->
582 <div style="display:inline"> 582 <div style="display:inline">
583 ( 583 (
584 <span id="typeTemplate"> 584 <span id="typeTemplate">
585 <span> 585 <span>
586 <span> 586 <span>
587 array of <span><span> 587 array of <span><span>
588 <span> 588 <span>
589 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 589 <a href="alarms.html#type-Alarm">Alarm</a>
590 </span> 590 </span>
591 </span></span> 591 </span></span>
592 </span> 592 </span>
593 </span> 593 </span>
594 </span> 594 </span>
595 ) 595 )
596 </div> 596 </div>
597 </em> 597 </em>
598 </dt> 598 </dt>
599 <dd class="todo"> 599 <dd class="todo">
(...skipping 16 matching lines...) Expand all
616 </dl> 616 </dl>
617 <!-- CALLBACK --> 617 <!-- CALLBACK -->
618 <div> 618 <div>
619 <div> 619 <div>
620 <h4>Callback function</h4> 620 <h4>Callback function</h4>
621 <p> 621 <p>
622 The <em>callback</em> parameter should specify a function 622 The <em>callback</em> parameter should specify a function
623 that looks like this: 623 that looks like this:
624 </p> 624 </p>
625 <!-- Note: intentionally longer 80 columns --> 625 <!-- Note: intentionally longer 80 columns -->
626 <pre>function(<span>array of alarms.Alarm alarms</span>) <span class="subdued">{...}</span>;</pre> 626 <pre>function(<span>array of Alarm alarms</span>) <span class= "subdued">{...}</span>;</pre>
627 <dl> 627 <dl>
628 <div> 628 <div>
629 <div> 629 <div>
630 <dt> 630 <dt>
631 <var>alarms</var> 631 <var>alarms</var>
632 <em> 632 <em>
633 <!-- TYPE --> 633 <!-- TYPE -->
634 <div style="display:inline"> 634 <div style="display:inline">
635 ( 635 (
636 <span id="typeTemplate"> 636 <span id="typeTemplate">
637 <span> 637 <span>
638 <span> 638 <span>
639 array of <span><span> 639 array of <span><span>
640 <span> 640 <span>
641 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 641 <a href="alarms.html#type-Alarm">Alarm</a>
642 </span> 642 </span>
643 </span></span> 643 </span></span>
644 </span> 644 </span>
645 </span> 645 </span>
646 </span> 646 </span>
647 ) 647 )
648 </div> 648 </div>
649 </em> 649 </em>
650 </dt> 650 </dt>
651 <dd class="todo"> 651 <dd class="todo">
(...skipping 15 matching lines...) Expand all
667 <!-- EVENTS --> 667 <!-- EVENTS -->
668 <div id="eventsTemplate" class="apiGroup"> 668 <div id="eventsTemplate" class="apiGroup">
669 <a name="global-events"></a> 669 <a name="global-events"></a>
670 <h3>Events</h3> 670 <h3>Events</h3>
671 <!-- iterates over all events --> 671 <!-- iterates over all events -->
672 <div class="apiItem"> 672 <div class="apiItem">
673 <a name="event-onAlarm"></a> 673 <a name="event-onAlarm"></a>
674 <h4>onAlarm</h4> 674 <h4>onAlarm</h4>
675 <div class="summary"> 675 <div class="summary">
676 <!-- Note: intentionally longer 80 columns --> 676 <!-- Note: intentionally longer 80 columns -->
677 <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>); 677 <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>);
678 </div> 678 </div>
679 <div class="description"> 679 <div class="description">
680 <p>Fired when an alarm has elapsed. Useful for transient backgro und pages.</p> 680 <p>Fired when an alarm has elapsed. Useful for transient backgro und pages.</p>
681 <!-- LISTENER PARAMETERS --> 681 <!-- LISTENER PARAMETERS -->
682 <div> 682 <div>
683 <h4>Listener parameters</h4> 683 <h4>Listener parameters</h4>
684 <dl> 684 <dl>
685 <div> 685 <div>
686 <div> 686 <div>
687 <dt> 687 <dt>
688 <var>alarm</var> 688 <var>alarm</var>
689 <em> 689 <em>
690 <!-- TYPE --> 690 <!-- TYPE -->
691 <div style="display:inline"> 691 <div style="display:inline">
692 ( 692 (
693 <span id="typeTemplate"> 693 <span id="typeTemplate">
694 <span> 694 <span>
695 <a href="alarms.html#type-alarms.Alarm">alarms.Alarm</a> 695 <a href="alarms.html#type-Alarm">Alarm</a>
696 </span> 696 </span>
697 </span> 697 </span>
698 ) 698 )
699 </div> 699 </div>
700 </em> 700 </em>
701 </dt> 701 </dt>
702 <dd>The alarm that has elapsed.</dd> 702 <dd>The alarm that has elapsed.</dd>
703 <!-- OBJECT PROPERTIES --> 703 <!-- OBJECT PROPERTIES -->
704 <!-- OBJECT METHODS --> 704 <!-- OBJECT METHODS -->
705 <!-- OBJECT EVENT FIELDS --> 705 <!-- OBJECT EVENT FIELDS -->
706 <!-- FUNCTION PARAMETERS --> 706 <!-- FUNCTION PARAMETERS -->
707 </div> 707 </div>
708 </div> 708 </div>
709 </dl> 709 </dl>
710 </div> 710 </div>
711 <!-- EXTRA PARAMETERS --> 711 <!-- EXTRA PARAMETERS -->
712 <!-- LISTENER RETURN VALUE --> 712 <!-- LISTENER RETURN VALUE -->
713 <dl> 713 <dl>
714 </dl> 714 </dl>
715 </div> <!-- /description --> 715 </div> <!-- /description -->
716 <!-- /description --> 716 <!-- /description -->
717 </div> <!-- /apiItem --> 717 </div> <!-- /apiItem -->
718 </div> <!-- /apiGroup --> 718 </div> <!-- /apiGroup -->
719 <!-- TYPES --> 719 <!-- TYPES -->
720 <div class="apiGroup"> 720 <div class="apiGroup">
721 <a name="types"></a> 721 <a name="types"></a>
722 <h3 id="types">Types</h3> 722 <h3 id="types">Types</h3>
723 <!-- iterates over all types --> 723 <!-- iterates over all types -->
724 <div class="apiItem"> 724 <div class="apiItem">
725 <a name="type-alarms.Alarm"></a> 725 <a name="type-Alarm"></a>
726 <h4>alarms.Alarm</h4> 726 <h4>Alarm</h4>
727 <div> 727 <div>
728 <dt> 728 <dt>
729 <em> 729 <em>
730 <!-- TYPE --> 730 <!-- TYPE -->
731 <div style="display:inline"> 731 <div style="display:inline">
732 ( 732 (
733 <span id="typeTemplate"> 733 <span id="typeTemplate">
734 <span> 734 <span>
735 <span>object</span> 735 <span>object</span>
736 </span> 736 </span>
(...skipping 79 matching lines...) Expand 10 before | Expand all | Expand 10 after
816 <!-- FUNCTION PARAMETERS --> 816 <!-- FUNCTION PARAMETERS -->
817 </div> 817 </div>
818 </div> 818 </div>
819 </dl> 819 </dl>
820 </dd> 820 </dd>
821 <!-- OBJECT METHODS --> 821 <!-- OBJECT METHODS -->
822 <!-- OBJECT EVENT FIELDS --> 822 <!-- OBJECT EVENT FIELDS -->
823 <!-- FUNCTION PARAMETERS --> 823 <!-- FUNCTION PARAMETERS -->
824 </div> 824 </div>
825 </div><div class="apiItem"> 825 </div><div class="apiItem">
826 <a name="type-alarms.AlarmCreateInfo"></a> 826 <a name="type-AlarmCreateInfo"></a>
827 <h4>alarms.AlarmCreateInfo</h4> 827 <h4>AlarmCreateInfo</h4>
828 <div> 828 <div>
829 <dt> 829 <dt>
830 <em> 830 <em>
831 <!-- TYPE --> 831 <!-- TYPE -->
832 <div style="display:inline"> 832 <div style="display:inline">
833 ( 833 (
834 <span id="typeTemplate"> 834 <span id="typeTemplate">
835 <span> 835 <span>
836 <span>object</span> 836 <span>object</span>
837 </span> 837 </span>
(...skipping 120 matching lines...) Expand 10 before | Expand all | Expand 10 after
958 _uff=0; 958 _uff=0;
959 urchinTracker(); 959 urchinTracker();
960 } 960 }
961 catch(e) {/* urchinTracker not available. */} 961 catch(e) {/* urchinTracker not available. */}
962 </script> 962 </script>
963 <!-- end analytics --> 963 <!-- end analytics -->
964 </div> 964 </div>
965 </div> <!-- /gc-footer --> 965 </div> <!-- /gc-footer -->
966 </div> <!-- /gc-container --> 966 </div> <!-- /gc-container -->
967 </body></html> 967 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/extension_api.cc ('k') | chrome/common/extensions/docs/api_index.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698