OLD | NEW |
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 Loading... |
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-Alarm">Alarm</a> | 225 <a href="#type-experimental.alarms.Alarm">experimental.alarms.Al
arm</a> |
226 <ol> | 226 <ol> |
227 </ol> | 227 </ol> |
228 </li><li> | 228 </li><li> |
229 <a href="#type-AlarmCreateInfo">AlarmCreateInfo</a> | 229 <a href="#type-experimental.alarms.AlarmCreateInfo">experimental
.alarms.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 74 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
314 </dl> | 314 </dl> |
315 <!-- CALLBACK --> | 315 <!-- CALLBACK --> |
316 <!-- MIN_VERSION --> | 316 <!-- MIN_VERSION --> |
317 </div> <!-- /description --> | 317 </div> <!-- /description --> |
318 </div><div class="apiItem"> | 318 </div><div class="apiItem"> |
319 <a name="method-create"></a> <!-- method-anchor --> | 319 <a name="method-create"></a> <!-- method-anchor --> |
320 <h4>create</h4> | 320 <h4>create</h4> |
321 <div class="summary"> | 321 <div class="summary"> |
322 <!-- Note: intentionally longer 80 columns --> | 322 <!-- Note: intentionally longer 80 columns --> |
323 <span>chrome.experimental.alarms.create</span>(<span class="op
tional"><span>string</span> | 323 <span>chrome.experimental.alarms.create</span>(<span class="op
tional"><span>string</span> |
324 <var><span>name</span></var></span><span class="null"><spa
n>, </span><span>AlarmCreateInfo</span> | 324 <var><span>name</span></var></span><span class="null"><spa
n>, </span><span>experimental.alarms.AlarmCreateInfo</span> |
325 <var><span>alarmInfo</span></var></span>)</div> | 325 <var><span>alarmInfo</span></var></span>)</div> |
326 <div class="description"> | 326 <div class="description"> |
327 <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> | 327 <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> |
328 <!-- PARAMETERS --> | 328 <!-- PARAMETERS --> |
329 <h4>Parameters</h4> | 329 <h4>Parameters</h4> |
330 <dl> | 330 <dl> |
331 <div> | 331 <div> |
332 <div> | 332 <div> |
333 <dt> | 333 <dt> |
334 <var>name</var> | 334 <var>name</var> |
(...skipping 20 matching lines...) Expand all Loading... |
355 </div><div> | 355 </div><div> |
356 <div> | 356 <div> |
357 <dt> | 357 <dt> |
358 <var>alarmInfo</var> | 358 <var>alarmInfo</var> |
359 <em> | 359 <em> |
360 <!-- TYPE --> | 360 <!-- TYPE --> |
361 <div style="display:inline"> | 361 <div style="display:inline"> |
362 ( | 362 ( |
363 <span id="typeTemplate"> | 363 <span id="typeTemplate"> |
364 <span> | 364 <span> |
365 <a href="experimental.alarms.html#type-AlarmCreateInfo">
AlarmCreateInfo</a> | 365 <a href="experimental.alarms.html#type-experimental.alar
ms.AlarmCreateInfo">experimental.alarms.AlarmCreateInfo</a> |
366 </span> | 366 </span> |
367 </span> | 367 </span> |
368 ) | 368 ) |
369 </div> | 369 </div> |
370 </em> | 370 </em> |
371 </dt> | 371 </dt> |
372 <dd class="todo"> | 372 <dd class="todo"> |
373 Undocumented. | 373 Undocumented. |
374 </dd> | 374 </dd> |
375 <!-- OBJECT PROPERTIES --> | 375 <!-- OBJECT PROPERTIES --> |
(...skipping 77 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
453 <div> | 453 <div> |
454 <div> | 454 <div> |
455 <dt> | 455 <dt> |
456 <var>alarm</var> | 456 <var>alarm</var> |
457 <em> | 457 <em> |
458 <!-- TYPE --> | 458 <!-- TYPE --> |
459 <div style="display:inline"> | 459 <div style="display:inline"> |
460 ( | 460 ( |
461 <span id="typeTemplate"> | 461 <span id="typeTemplate"> |
462 <span> | 462 <span> |
463 <a href="experimental.alarms.html#type-Alarm">Alarm</a> | 463 <a href="experimental.alarms.html#type-experimental.alar
ms.Alarm">experimental.alarms.Alarm</a> |
464 </span> | 464 </span> |
465 </span> | 465 </span> |
466 ) | 466 ) |
467 </div> | 467 </div> |
468 </em> | 468 </em> |
469 </dt> | 469 </dt> |
470 <dd class="todo"> | 470 <dd class="todo"> |
471 Undocumented. | 471 Undocumented. |
472 </dd> | 472 </dd> |
473 <!-- OBJECT PROPERTIES --> | 473 <!-- OBJECT PROPERTIES --> |
(...skipping 13 matching lines...) Expand all Loading... |
487 </dl> | 487 </dl> |
488 <!-- CALLBACK --> | 488 <!-- CALLBACK --> |
489 <div> | 489 <div> |
490 <div> | 490 <div> |
491 <h4>Callback function</h4> | 491 <h4>Callback function</h4> |
492 <p> | 492 <p> |
493 The callback <em>parameter</em> should specify a function | 493 The callback <em>parameter</em> should specify a function |
494 that looks like this: | 494 that looks like this: |
495 </p> | 495 </p> |
496 <!-- Note: intentionally longer 80 columns --> | 496 <!-- Note: intentionally longer 80 columns --> |
497 <pre>function(<span>Alarm alarm</span>) <span class="subdued">
{...}</span>;</pre> | 497 <pre>function(<span>experimental.alarms.Alarm alarm</span>) <s
pan class="subdued">{...}</span>;</pre> |
498 <dl> | 498 <dl> |
499 <div> | 499 <div> |
500 <div> | 500 <div> |
501 <dt> | 501 <dt> |
502 <var>alarm</var> | 502 <var>alarm</var> |
503 <em> | 503 <em> |
504 <!-- TYPE --> | 504 <!-- TYPE --> |
505 <div style="display:inline"> | 505 <div style="display:inline"> |
506 ( | 506 ( |
507 <span id="typeTemplate"> | 507 <span id="typeTemplate"> |
508 <span> | 508 <span> |
509 <a href="experimental.alarms.html#type-Alarm">Alarm</a> | 509 <a href="experimental.alarms.html#type-experimental.alar
ms.Alarm">experimental.alarms.Alarm</a> |
510 </span> | 510 </span> |
511 </span> | 511 </span> |
512 ) | 512 ) |
513 </div> | 513 </div> |
514 </em> | 514 </em> |
515 </dt> | 515 </dt> |
516 <dd class="todo"> | 516 <dd class="todo"> |
517 Undocumented. | 517 Undocumented. |
518 </dd> | 518 </dd> |
519 <!-- OBJECT PROPERTIES --> | 519 <!-- OBJECT PROPERTIES --> |
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
573 <var>alarms</var> | 573 <var>alarms</var> |
574 <em> | 574 <em> |
575 <!-- TYPE --> | 575 <!-- TYPE --> |
576 <div style="display:inline"> | 576 <div style="display:inline"> |
577 ( | 577 ( |
578 <span id="typeTemplate"> | 578 <span id="typeTemplate"> |
579 <span> | 579 <span> |
580 <span> | 580 <span> |
581 array of <span><span> | 581 array of <span><span> |
582 <span> | 582 <span> |
583 <a href="experimental.alarms.html#type-Alarm">Alarm</a> | 583 <a href="experimental.alarms.html#type-experimental.alar
ms.Alarm">experimental.alarms.Alarm</a> |
584 </span> | 584 </span> |
585 </span></span> | 585 </span></span> |
586 </span> | 586 </span> |
587 </span> | 587 </span> |
588 </span> | 588 </span> |
589 ) | 589 ) |
590 </div> | 590 </div> |
591 </em> | 591 </em> |
592 </dt> | 592 </dt> |
593 <dd class="todo"> | 593 <dd class="todo"> |
(...skipping 16 matching lines...) Expand all Loading... |
610 </dl> | 610 </dl> |
611 <!-- CALLBACK --> | 611 <!-- CALLBACK --> |
612 <div> | 612 <div> |
613 <div> | 613 <div> |
614 <h4>Callback function</h4> | 614 <h4>Callback function</h4> |
615 <p> | 615 <p> |
616 The callback <em>parameter</em> should specify a function | 616 The callback <em>parameter</em> should specify a function |
617 that looks like this: | 617 that looks like this: |
618 </p> | 618 </p> |
619 <!-- Note: intentionally longer 80 columns --> | 619 <!-- Note: intentionally longer 80 columns --> |
620 <pre>function(<span>array of Alarm alarms</span>) <span class=
"subdued">{...}</span>;</pre> | 620 <pre>function(<span>array of experimental.alarms.Alarm alarms<
/span>) <span class="subdued">{...}</span>;</pre> |
621 <dl> | 621 <dl> |
622 <div> | 622 <div> |
623 <div> | 623 <div> |
624 <dt> | 624 <dt> |
625 <var>alarms</var> | 625 <var>alarms</var> |
626 <em> | 626 <em> |
627 <!-- TYPE --> | 627 <!-- TYPE --> |
628 <div style="display:inline"> | 628 <div style="display:inline"> |
629 ( | 629 ( |
630 <span id="typeTemplate"> | 630 <span id="typeTemplate"> |
631 <span> | 631 <span> |
632 <span> | 632 <span> |
633 array of <span><span> | 633 array of <span><span> |
634 <span> | 634 <span> |
635 <a href="experimental.alarms.html#type-Alarm">Alarm</a> | 635 <a href="experimental.alarms.html#type-experimental.alar
ms.Alarm">experimental.alarms.Alarm</a> |
636 </span> | 636 </span> |
637 </span></span> | 637 </span></span> |
638 </span> | 638 </span> |
639 </span> | 639 </span> |
640 </span> | 640 </span> |
641 ) | 641 ) |
642 </div> | 642 </div> |
643 </em> | 643 </em> |
644 </dt> | 644 </dt> |
645 <dd class="todo"> | 645 <dd class="todo"> |
(...skipping 15 matching lines...) Expand all Loading... |
661 <!-- EVENTS --> | 661 <!-- EVENTS --> |
662 <div id="eventsTemplate" class="apiGroup"> | 662 <div id="eventsTemplate" class="apiGroup"> |
663 <a name="global-events"></a> | 663 <a name="global-events"></a> |
664 <h3>Events</h3> | 664 <h3>Events</h3> |
665 <!-- iterates over all events --> | 665 <!-- iterates over all events --> |
666 <div class="apiItem"> | 666 <div class="apiItem"> |
667 <a name="event-onAlarm"></a> | 667 <a name="event-onAlarm"></a> |
668 <h4>onAlarm</h4> | 668 <h4>onAlarm</h4> |
669 <div class="summary"> | 669 <div class="summary"> |
670 <!-- Note: intentionally longer 80 columns --> | 670 <!-- Note: intentionally longer 80 columns --> |
671 <span class="subdued">chrome.experimental.alarms.</span><span>on
Alarm</span><span class="subdued">.addListener</span>(function(<span>Alarm alarm
</span>) <span class="subdued">{...}</span><span></span>); | 671 <span class="subdued">chrome.experimental.alarms.</span><span>on
Alarm</span><span class="subdued">.addListener</span>(function(<span>experimenta
l.alarms.Alarm alarm</span>) <span class="subdued">{...}</span><span></span>); |
672 </div> | 672 </div> |
673 <div class="description"> | 673 <div class="description"> |
674 <p>Fired when an alarm has elapsed. Useful for transient backgro
und pages.</p> | 674 <p>Fired when an alarm has elapsed. Useful for transient backgro
und pages.</p> |
675 <!-- LISTENER PARAMETERS --> | 675 <!-- LISTENER PARAMETERS --> |
676 <div> | 676 <div> |
677 <h4>Listener parameters</h4> | 677 <h4>Listener parameters</h4> |
678 <dl> | 678 <dl> |
679 <div> | 679 <div> |
680 <div> | 680 <div> |
681 <dt> | 681 <dt> |
682 <var>alarm</var> | 682 <var>alarm</var> |
683 <em> | 683 <em> |
684 <!-- TYPE --> | 684 <!-- TYPE --> |
685 <div style="display:inline"> | 685 <div style="display:inline"> |
686 ( | 686 ( |
687 <span id="typeTemplate"> | 687 <span id="typeTemplate"> |
688 <span> | 688 <span> |
689 <a href="experimental.alarms.html#type-Alarm">Alarm</a> | 689 <a href="experimental.alarms.html#type-experimental.alar
ms.Alarm">experimental.alarms.Alarm</a> |
690 </span> | 690 </span> |
691 </span> | 691 </span> |
692 ) | 692 ) |
693 </div> | 693 </div> |
694 </em> | 694 </em> |
695 </dt> | 695 </dt> |
696 <dd>The alarm that has elapsed.</dd> | 696 <dd>The alarm that has elapsed.</dd> |
697 <!-- OBJECT PROPERTIES --> | 697 <!-- OBJECT PROPERTIES --> |
698 <!-- OBJECT METHODS --> | 698 <!-- OBJECT METHODS --> |
699 <!-- OBJECT EVENT FIELDS --> | 699 <!-- OBJECT EVENT FIELDS --> |
700 <!-- FUNCTION PARAMETERS --> | 700 <!-- FUNCTION PARAMETERS --> |
701 </div> | 701 </div> |
702 </div> | 702 </div> |
703 </dl> | 703 </dl> |
704 </div> | 704 </div> |
705 <!-- EXTRA PARAMETERS --> | 705 <!-- EXTRA PARAMETERS --> |
706 <!-- LISTENER RETURN VALUE --> | 706 <!-- LISTENER RETURN VALUE --> |
707 <dl> | 707 <dl> |
708 </dl> | 708 </dl> |
709 </div> <!-- /description --> | 709 </div> <!-- /description --> |
710 </div> <!-- /apiItem --> | 710 </div> <!-- /apiItem --> |
711 </div> <!-- /apiGroup --> | 711 </div> <!-- /apiGroup --> |
712 <!-- TYPES --> | 712 <!-- TYPES --> |
713 <div class="apiGroup"> | 713 <div class="apiGroup"> |
714 <a name="types"></a> | 714 <a name="types"></a> |
715 <h3 id="types">Types</h3> | 715 <h3 id="types">Types</h3> |
716 <!-- iterates over all types --> | 716 <!-- iterates over all types --> |
717 <div class="apiItem"> | 717 <div class="apiItem"> |
718 <a name="type-Alarm"></a> | 718 <a name="type-experimental.alarms.Alarm"></a> |
719 <h4>Alarm</h4> | 719 <h4>experimental.alarms.Alarm</h4> |
720 <div> | 720 <div> |
721 <dt> | 721 <dt> |
722 <em> | 722 <em> |
723 <!-- TYPE --> | 723 <!-- TYPE --> |
724 <div style="display:inline"> | 724 <div style="display:inline"> |
725 ( | 725 ( |
726 <span id="typeTemplate"> | 726 <span id="typeTemplate"> |
727 <span> | 727 <span> |
728 <span>object</span> | 728 <span>object</span> |
729 </span> | 729 </span> |
(...skipping 78 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
808 <!-- FUNCTION PARAMETERS --> | 808 <!-- FUNCTION PARAMETERS --> |
809 </div> | 809 </div> |
810 </div> | 810 </div> |
811 </dl> | 811 </dl> |
812 </dd> | 812 </dd> |
813 <!-- OBJECT METHODS --> | 813 <!-- OBJECT METHODS --> |
814 <!-- OBJECT EVENT FIELDS --> | 814 <!-- OBJECT EVENT FIELDS --> |
815 <!-- FUNCTION PARAMETERS --> | 815 <!-- FUNCTION PARAMETERS --> |
816 </div> | 816 </div> |
817 </div><div class="apiItem"> | 817 </div><div class="apiItem"> |
818 <a name="type-AlarmCreateInfo"></a> | 818 <a name="type-experimental.alarms.AlarmCreateInfo"></a> |
819 <h4>AlarmCreateInfo</h4> | 819 <h4>experimental.alarms.AlarmCreateInfo</h4> |
820 <div> | 820 <div> |
821 <dt> | 821 <dt> |
822 <em> | 822 <em> |
823 <!-- TYPE --> | 823 <!-- TYPE --> |
824 <div style="display:inline"> | 824 <div style="display:inline"> |
825 ( | 825 ( |
826 <span id="typeTemplate"> | 826 <span id="typeTemplate"> |
827 <span> | 827 <span> |
828 <span>object</span> | 828 <span>object</span> |
829 </span> | 829 </span> |
(...skipping 95 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
925 _uff=0; | 925 _uff=0; |
926 urchinTracker(); | 926 urchinTracker(); |
927 } | 927 } |
928 catch(e) {/* urchinTracker not available. */} | 928 catch(e) {/* urchinTracker not available. */} |
929 </script> | 929 </script> |
930 <!-- end analytics --> | 930 <!-- end analytics --> |
931 </div> | 931 </div> |
932 </div> <!-- /gc-footer --> | 932 </div> <!-- /gc-footer --> |
933 </div> <!-- /gc-container --> | 933 </div> <!-- /gc-container --> |
934 </body></html> | 934 </body></html> |
OLD | NEW |