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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10066024: Convert chrome.experimental.alarms API to use IDL. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 8 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
« chrome/common/extensions/api/experimental.alarms.idl ('K') | « chrome/common/extensions/api/extension_api.cc ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(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.al arms module, which is part of the Google Chrome extension APIs."><title>chrome. experimental.alarms - 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&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;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">chrome.experimental.alarms</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.alarm s</a>
196 <ol>
197 <li>
198 <a href="#global-methods">Methods</a>
199 <ol>
200 <li>
201 <a href="#method-clear">clear</a>
202 </li><li>
203 <a href="#method-clearAll">clearAll</a>
204 </li><li>
205 <a href="#method-create">create</a>
206 </li><li>
207 <a href="#method-get">get</a>
208 </li><li>
209 <a href="#method-getAll">getAll</a>
210 </li>
211 </ol>
212 </li>
213 <li>
214 <a href="#global-events">Events</a>
215 <ol>
216 <li>
217 <a href="#event-onAlarm">onAlarm</a>
218 </li>
219 </ol>
220 </li>
221 <li>
222 <a href="#types">Types</a>
223 <ol>
224 <li>
225 <a href="#type-Alarm">Alarm</a>
226 <ol>
227 </ol>
228 </li>
229 </ol>
230 </li>
231 </ol>
232 </li>
233 </ol>
234 </div>
235 <!-- /TABLE OF CONTENTS -->
236 <!-- Standard content lead-in for experimental API pages -->
237 <p id="classSummary">
238 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
239 </p>
240 <!-- STATIC CONTENT PLACEHOLDER -->
241 <div id="static"></div>
242 <!-- API PAGE -->
243 <div class="apiPage">
244 <a name="apiReference"></a>
245 <h2>API reference: chrome.experimental.alarms</h2>
246 <!-- PROPERTIES -->
247 <!-- /apiGroup -->
248 <!-- METHODS -->
249 <div id="methodsTemplate" class="apiGroup">
250 <a name="global-methods"></a>
251 <h3>Methods</h3>
252 <!-- iterates over all functions -->
253 <div class="apiItem">
254 <a name="method-clear"></a> <!-- method-anchor -->
255 <h4>clear</h4>
256 <div class="summary">
257 <!-- Note: intentionally longer 80 columns -->
258 <span>chrome.experimental.alarms.clear</span>(<span class="opt ional"><span>string</span>
259 <var><span>name</span></var></span>)</div>
260 <div class="description">
261 <p>Clears the alarm with the given name.</p>
262 <!-- PARAMETERS -->
263 <h4>Parameters</h4>
264 <dl>
265 <div>
266 <div>
267 <dt>
268 <var>name</var>
269 <em>
270 <!-- TYPE -->
271 <div style="display:inline">
272 (
273 <span class="optional">optional</span>
274 <span id="typeTemplate">
275 <span>
276 <span>string</span>
277 </span>
278 </span>
279 )
280 </div>
281 </em>
282 </dt>
283 <dd>The name of the alarm to clear. Defaults to the empty string.</dd>
284 <!-- OBJECT PROPERTIES -->
285 <!-- OBJECT METHODS -->
286 <!-- OBJECT EVENT FIELDS -->
287 <!-- FUNCTION PARAMETERS -->
288 </div>
289 </div>
290 </dl>
291 <!-- RETURNS -->
292 <dl>
293 </dl>
294 <!-- CALLBACK -->
295 <!-- MIN_VERSION -->
296 </div> <!-- /description -->
297 </div><div class="apiItem">
298 <a name="method-clearAll"></a> <!-- method-anchor -->
299 <h4>clearAll</h4>
300 <div class="summary">
301 <!-- Note: intentionally longer 80 columns -->
302 <span>chrome.experimental.alarms.clearAll</span>()</div>
303 <div class="description">
304 <p>Clears all alarms.</p>
305 <!-- PARAMETERS -->
306 <dl>
307 </dl>
308 <!-- RETURNS -->
309 <dl>
310 </dl>
311 <!-- CALLBACK -->
312 <!-- MIN_VERSION -->
313 </div> <!-- /description -->
314 </div><div class="apiItem">
315 <a name="method-create"></a> <!-- method-anchor -->
316 <h4>create</h4>
317 <div class="summary">
318 <!-- Note: intentionally longer 80 columns -->
319 <span>chrome.experimental.alarms.create</span>(<span class="op tional"><span>string</span>
320 <var><span>name</span></var></span><span class="null"><spa n>, </span><span>object</span>
321 <var><span>alarmInfo</span></var></span>)</div>
322 <div class="description">
323 <p>Creates an alarm. After the delay is expired, 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.</p>
324 <!-- PARAMETERS -->
325 <h4>Parameters</h4>
326 <dl>
327 <div>
328 <div>
329 <dt>
330 <var>name</var>
331 <em>
332 <!-- TYPE -->
333 <div style="display:inline">
334 (
335 <span class="optional">optional</span>
336 <span id="typeTemplate">
337 <span>
338 <span>string</span>
339 </span>
340 </span>
341 )
342 </div>
343 </em>
344 </dt>
345 <dd>Optional name to identify this alarm. Defaults to the empty string .</dd>
346 <!-- OBJECT PROPERTIES -->
347 <!-- OBJECT METHODS -->
348 <!-- OBJECT EVENT FIELDS -->
349 <!-- FUNCTION PARAMETERS -->
350 </div>
351 </div><div>
352 <div>
353 <dt>
354 <var>alarmInfo</var>
355 <em>
356 <!-- TYPE -->
357 <div style="display:inline">
358 (
359 <span id="typeTemplate">
360 <span>
361 <span>object</span>
362 </span>
363 </span>
364 )
365 </div>
366 </em>
367 </dt>
368 <dd class="todo">
369 Undocumented.
370 </dd>
371 <!-- OBJECT PROPERTIES -->
372 <dd>
373 <dl>
374 <div>
375 <div>
376 <dt>
377 <var>delayInSeconds</var>
378 <em>
379 <!-- TYPE -->
380 <div style="display:inline">
381 (
382 <span id="typeTemplate">
383 <span>
384 <span>integer</span>
385 </span>
386 </span>
387 )
388 </div>
389 </em>
390 </dt>
391 <dd>Length of time in seconds after which the onAlarm event should fir e. Note that granularity is not guaranteed: this value is more of a hint to the browser. For performance reasons, alarms may be delayed an arbitrary amount of t ime before firing.</dd>
392 <!-- OBJECT PROPERTIES -->
393 <!-- OBJECT METHODS -->
394 <!-- OBJECT EVENT FIELDS -->
395 <!-- FUNCTION PARAMETERS -->
396 </div>
397 </div><div>
398 <div>
399 <dt>
400 <var>repeating</var>
401 <em>
402 <!-- TYPE -->
403 <div style="display:inline">
404 (
405 <span class="optional">optional</span>
406 <span id="typeTemplate">
407 <span>
408 <span>boolean</span>
409 </span>
410 </span>
411 )
412 </div>
413 </em>
414 </dt>
415 <dd>True if the alarm should repeatedly fire at regular intervals. Def aults to false.</dd>
416 <!-- OBJECT PROPERTIES -->
417 <!-- OBJECT METHODS -->
418 <!-- OBJECT EVENT FIELDS -->
419 <!-- FUNCTION PARAMETERS -->
420 </div>
421 </div>
422 </dl>
423 </dd>
424 <!-- OBJECT METHODS -->
425 <!-- OBJECT EVENT FIELDS -->
426 <!-- FUNCTION PARAMETERS -->
427 </div>
428 </div>
429 </dl>
430 <!-- RETURNS -->
431 <dl>
432 </dl>
433 <!-- CALLBACK -->
434 <!-- MIN_VERSION -->
435 </div> <!-- /description -->
436 </div><div class="apiItem">
437 <a name="method-get"></a> <!-- method-anchor -->
438 <h4>get</h4>
439 <div class="summary">
440 <!-- Note: intentionally longer 80 columns -->
441 <span>chrome.experimental.alarms.get</span>(<span class="optio nal"><span>string</span>
442 <var><span>name</span></var></span><span class="null"><spa n>, </span><span>function</span>
443 <var><span>callback</span></var></span>)</div>
444 <div class="description">
445 <p>Retrieves details about the specified alarm.</p>
446 <!-- PARAMETERS -->
447 <h4>Parameters</h4>
448 <dl>
449 <div>
450 <div>
451 <dt>
452 <var>name</var>
453 <em>
454 <!-- TYPE -->
455 <div style="display:inline">
456 (
457 <span class="optional">optional</span>
458 <span id="typeTemplate">
459 <span>
460 <span>string</span>
461 </span>
462 </span>
463 )
464 </div>
465 </em>
466 </dt>
467 <dd>The name of the alarm to get. Defaults to the empty string.</dd>
468 <!-- OBJECT PROPERTIES -->
469 <!-- OBJECT METHODS -->
470 <!-- OBJECT EVENT FIELDS -->
471 <!-- FUNCTION PARAMETERS -->
472 </div>
473 </div><div>
474 <div>
475 <dt>
476 <var>callback</var>
477 <em>
478 <!-- TYPE -->
479 <div style="display:inline">
480 (
481 <span id="typeTemplate">
482 <span>
483 <span>function</span>
484 </span>
485 </span>
486 )
487 </div>
488 </em>
489 </dt>
490 <dd class="todo">
491 Undocumented.
492 </dd>
493 <!-- OBJECT PROPERTIES -->
494 <!-- OBJECT METHODS -->
495 <!-- OBJECT EVENT FIELDS -->
496 <!-- FUNCTION PARAMETERS -->
497 </div>
498 </div>
499 </dl>
500 <!-- RETURNS -->
501 <dl>
502 </dl>
503 <!-- CALLBACK -->
504 <div>
505 <div>
506 <h4>Callback function</h4>
507 <p>
508 The callback <em>parameter</em> should specify a function
509 that looks like this:
510 </p>
511 <!-- Note: intentionally longer 80 columns -->
512 <pre>function(<span>Alarm alarm</span>) <span class="subdued"> {...}</span>;</pre>
513 <dl>
514 <div>
515 <div>
516 <dt>
517 <var>alarm</var>
518 <em>
519 <!-- TYPE -->
520 <div style="display:inline">
521 (
522 <span id="typeTemplate">
523 <span>
524 <a href="experimental.alarms.html#type-Alarm">Alarm</a>
525 </span>
526 </span>
527 )
528 </div>
529 </em>
530 </dt>
531 <dd class="todo">
532 Undocumented.
533 </dd>
534 <!-- OBJECT PROPERTIES -->
535 <!-- OBJECT METHODS -->
536 <!-- OBJECT EVENT FIELDS -->
537 <!-- FUNCTION PARAMETERS -->
538 </div>
539 </div>
540 </dl>
541 </div>
542 </div>
543 <!-- MIN_VERSION -->
544 </div> <!-- /description -->
545 </div><div class="apiItem">
546 <a name="method-getAll"></a> <!-- method-anchor -->
547 <h4>getAll</h4>
548 <div class="summary">
549 <!-- Note: intentionally longer 80 columns -->
550 <span>chrome.experimental.alarms.getAll</span>(<span class="nu ll"><span>function</span>
551 <var><span>callback</span></var></span>)</div>
552 <div class="description">
553 <p>Gets an array of all the alarms.</p>
554 <!-- PARAMETERS -->
555 <h4>Parameters</h4>
556 <dl>
557 <div>
558 <div>
559 <dt>
560 <var>callback</var>
561 <em>
562 <!-- TYPE -->
563 <div style="display:inline">
564 (
565 <span id="typeTemplate">
566 <span>
567 <span>function</span>
568 </span>
569 </span>
570 )
571 </div>
572 </em>
573 </dt>
574 <dd class="todo">
575 Undocumented.
576 </dd>
577 <!-- OBJECT PROPERTIES -->
578 <!-- OBJECT METHODS -->
579 <!-- OBJECT EVENT FIELDS -->
580 <!-- FUNCTION PARAMETERS -->
581 </div>
582 </div>
583 </dl>
584 <!-- RETURNS -->
585 <dl>
586 </dl>
587 <!-- CALLBACK -->
588 <div>
589 <div>
590 <h4>Callback function</h4>
591 <p>
592 The callback <em>parameter</em> should specify a function
593 that looks like this:
594 </p>
595 <!-- Note: intentionally longer 80 columns -->
596 <pre>function(<span>array of Alarm alarms</span>) <span class= "subdued">{...}</span>;</pre>
597 <dl>
598 <div>
599 <div>
600 <dt>
601 <var>alarms</var>
602 <em>
603 <!-- TYPE -->
604 <div style="display:inline">
605 (
606 <span id="typeTemplate">
607 <span>
608 <span>
609 array of <span><span>
610 <span>
611 <a href="experimental.alarms.html#type-Alarm">Alarm</a>
612 </span>
613 </span></span>
614 </span>
615 </span>
616 </span>
617 )
618 </div>
619 </em>
620 </dt>
621 <dd class="todo">
622 Undocumented.
623 </dd>
624 <!-- OBJECT PROPERTIES -->
625 <!-- OBJECT METHODS -->
626 <!-- OBJECT EVENT FIELDS -->
627 <!-- FUNCTION PARAMETERS -->
628 </div>
629 </div>
630 </dl>
631 </div>
632 </div>
633 <!-- MIN_VERSION -->
634 </div> <!-- /description -->
635 </div> <!-- /apiItem -->
636 </div> <!-- /apiGroup -->
637 <!-- EVENTS -->
638 <div id="eventsTemplate" class="apiGroup">
639 <a name="global-events"></a>
640 <h3>Events</h3>
641 <!-- iterates over all events -->
642 <div class="apiItem">
643 <a name="event-onAlarm"></a>
644 <h4>onAlarm</h4>
645 <div class="summary">
646 <!-- Note: intentionally longer 80 columns -->
647 <span class="subdued">chrome.experimental.alarms.</span><span>on Alarm</span><span class="subdued">.addListener</span>(function(<span>string name </span>) <span class="subdued">{...}</span><span></span>);
648 </div>
649 <div class="description">
650 <p>Fired when an alarm has expired. Useful for transient backgro und pages.</p>
651 <!-- LISTENER PARAMETERS -->
652 <div>
653 <h4>Listener parameters</h4>
654 <dl>
655 <div>
656 <div>
657 <dt>
658 <var>name</var>
659 <em>
660 <!-- TYPE -->
661 <div style="display:inline">
662 (
663 <span class="optional">optional</span>
664 <span id="typeTemplate">
665 <span>
666 <span>string</span>
667 </span>
668 </span>
669 )
670 </div>
671 </em>
672 </dt>
673 <dd>The name of the alarm that has expired.</dd>
674 <!-- OBJECT PROPERTIES -->
675 <!-- OBJECT METHODS -->
676 <!-- OBJECT EVENT FIELDS -->
677 <!-- FUNCTION PARAMETERS -->
678 </div>
679 </div>
680 </dl>
681 </div>
682 <!-- EXTRA PARAMETERS -->
683 <!-- LISTENER RETURN VALUE -->
684 <dl>
685 </dl>
686 </div> <!-- /description -->
687 </div> <!-- /apiItem -->
688 </div> <!-- /apiGroup -->
689 <!-- TYPES -->
690 <div class="apiGroup">
691 <a name="types"></a>
692 <h3 id="types">Types</h3>
693 <!-- iterates over all types -->
694 <div class="apiItem">
695 <a name="type-Alarm"></a>
696 <h4>Alarm</h4>
697 <div>
698 <dt>
699 <em>
700 <!-- TYPE -->
701 <div style="display:inline">
702 (
703 <span id="typeTemplate">
704 <span>
705 <span>object</span>
706 </span>
707 </span>
708 )
709 </div>
710 </em>
711 </dt>
712 <dd class="todo">
713 Undocumented.
714 </dd>
715 <!-- OBJECT PROPERTIES -->
716 <dd>
717 <dl>
718 <div>
719 <div>
720 <dt>
721 <var>name</var>
722 <em>
723 <!-- TYPE -->
724 <div style="display:inline">
725 (
726 <span id="typeTemplate">
727 <span>
728 <span>string</span>
729 </span>
730 </span>
731 )
732 </div>
733 </em>
734 </dt>
735 <dd>Name of this alarm.</dd>
736 <!-- OBJECT PROPERTIES -->
737 <!-- OBJECT METHODS -->
738 <!-- OBJECT EVENT FIELDS -->
739 <!-- FUNCTION PARAMETERS -->
740 </div>
741 </div><div>
742 <div>
743 <dt>
744 <var>delayInSeconds</var>
745 <em>
746 <!-- TYPE -->
747 <div style="display:inline">
748 (
749 <span id="typeTemplate">
750 <span>
751 <span>integer</span>
752 </span>
753 </span>
754 )
755 </div>
756 </em>
757 </dt>
758 <dd>Original length of time in seconds after which the onAlarm event s hould fire.</dd>
759 <!-- OBJECT PROPERTIES -->
760 <!-- OBJECT METHODS -->
761 <!-- OBJECT EVENT FIELDS -->
762 <!-- FUNCTION PARAMETERS -->
763 </div>
764 </div><div>
765 <div>
766 <dt>
767 <var>repeating</var>
768 <em>
769 <!-- TYPE -->
770 <div style="display:inline">
771 (
772 <span id="typeTemplate">
773 <span>
774 <span>boolean</span>
775 </span>
776 </span>
777 )
778 </div>
779 </em>
780 </dt>
781 <dd>True if the alarm repeatedly fires at regular intervals, false if it only fires once.</dd>
782 <!-- OBJECT PROPERTIES -->
783 <!-- OBJECT METHODS -->
784 <!-- OBJECT EVENT FIELDS -->
785 <!-- FUNCTION PARAMETERS -->
786 </div>
787 </div>
788 </dl>
789 </dd>
790 <!-- OBJECT METHODS -->
791 <!-- OBJECT EVENT FIELDS -->
792 <!-- FUNCTION PARAMETERS -->
793 </div>
794 </div> <!-- /apiItem -->
795 </div> <!-- /apiGroup -->
796 </div> <!-- /apiPage -->
797 </div> <!-- /gc-pagecontent -->
798 </div> <!-- /g-section -->
799 </div> <!-- /codesiteContent -->
800 <div id="gc-footer" --="">
801 <div class="text">
802 <p>
803 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
804 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
805 Attribution 3.0 License</a>, and code samples are licensed under the
806 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
807 </p>
808 <p>
809 ©2011 Google
810 </p>
811 <!-- begin analytics -->
812 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
813 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
814 <script type="text/javascript">
815 // chrome doc tracking
816 try {
817 var engdocs = _gat._getTracker("YT-10763712-2");
818 engdocs._trackPageview();
819 } catch(err) {}
820 // code.google.com site-wide tracking
821 try {
822 _uacct="UA-18071-1";
823 _uanchor=1;
824 _uff=0;
825 urchinTracker();
826 }
827 catch(e) {/* urchinTracker not available. */}
828 </script>
829 <!-- end analytics -->
830 </div>
831 </div> <!-- /gc-footer -->
832 </div> <!-- /gc-container -->
833 </body></html>
OLDNEW
« chrome/common/extensions/api/experimental.alarms.idl ('K') | « chrome/common/extensions/api/extension_api.cc ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698