What's new? | Help | Directory | Sign in
Google
gears
Improving Your Web Browser
Project Home
  
Wiki
  
Issues
  
Source
    
Checkout | Browse | Changes |
  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">

<!--
Copyright 2007, Google Inc.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

 1. Redistributions of source code must retain the above copyright notice, 
    this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
 3. Neither the name of Google Inc. nor the names of its contributors may be
    used to endorse or promote products derived from this software without
    specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-->

<html>
  <head>
    <title>Timer API</title>
    <link rel="stylesheet" type="text/css" href="gears.css" />
  </head>

<body>

<h1>Timer API</h1>

<div id="pagecontent">

<p>The Timer module implements the <a
  href="http://www.whatwg.org/specs/web-apps/current-work/multipage/section-timers.html">WhatWG
  Timer specification</a>, and makes it available in both workers and the main
  HTML page.  This is the same timer API that is traditionally available in
  browsers on the <code>window</code> object.


<h3>Contents</h3>

  <ol class="toc">
  <li><a href="#overview">Overview</a>
  <li><a href="#example">Example</a>
  <li><a href="#timer_class">Timer class</a>
  </ol>



<h2 id="overview">Overview</h2>

<p>Since workers don't have access to the window object, they also don't have
access to the standard timer functionality.  The Timer module exposes similar
functionality that can be used both in the main page and in workers.  This
allows code to be shared across both contexts.
<h4>Permission</h4>

<p>Does not require user permission.</p>

<h2 id="example">Example</h2>

<pre><code>&lt;script type="text/javascript" src="<a href='tools.html#gears_init'>gears_init.js</a>"&gt;&lt;/script&gt;
&lt;script type="text/javascript"&gt;
var timer = google.gears.factory.create('beta.timer');
timer.setTimeout(function() { alert('Hello, from the future!'); },
                 1000);
&lt;/script&gt;</code></pre>


<h2 id="timer_class">Timer class</h2>

<pre><code>int  <b>setTimeout</b>(fullScript, msecDelay)
int  <b>setTimeout</b>(function, msecDelay)
int  <b>setInterval</b>(fullScript, msecDelay)
int  <b>setInterval</b>(function, msecDelay)
void <b>clearTimeout</b>(timerId)
void <b>clearInterval</b>(timerId)</code></pre>
<br>


<h3>Methods</h3>

<table>
  <tr class="odd">
    <th colspan="2"><div align="left"><code>setTimeout(function, msecDelay)</code></div></th>
  </tr>
  <tr class="odd">
    <td>Parameters:</td>
    <td class="odd"><code>function</code> <br />
      <code>msecDelay</code></td>
  </tr>
  <tr class="odd">
    <td width="113">Return value:</td>
    <td width="489">The ID of the new timeout.</td>
  </tr>
  <tr class="odd">
    <td>Description:</td>
    <td class="odd">
      Creates a timeout that will call <code>function</code> after
      <code>msecDelay</code> milliseconds have elapsed.
      <br><br>
      Timer IDs are guaranteed to be unique values that are never reused
      within the same Timer.
    </td>
  </tr>
</table>
<table>
  <tr class="odd">
    <th colspan="2"><div align="left"><code>setTimeout(fullScript, msecDelay)</code></div></th>
  </tr>
  <tr class="odd">
    <td>Parameters:</td>
    <td class="odd"><code>fullScript</code><code> <br />
      <code>msecDelay</code></td>
  </tr>
  <tr class="odd">
    <td width="113">Return value: </td>
    <td width="489">The ID of the new timeout.</td>
  </tr>
  <tr class="odd">
    <td>Description:</td>
    <td class="odd">
      Creates a timeout that will evaluate <code>fullScript</code>
      after <code>msecDelay</code> milliseconds have elapsed.
      <br><br>
      Timer IDs are guaranteed to be unique values that are never reused
      within the same Timer.
    </td>
  </tr>
</table>
<table>
  <tr class="odd">
    <th colspan="2"><div align="left"><code>setInterval(function, msecDelay)</code></div></th>
  </tr>
  <tr class="odd">
    <td>Parameters:</td>
    <td class="odd"><code>function</code><code> <br />
      <code>msecDelay</code></td>
  </tr>
  <tr class="odd">
    <td width="113">Return value:</td>
    <td width="489">The ID of the new interval.</td>
  </tr>
  <tr class="odd">
    <td>Description:</td>
    <td class="odd">
      Creates an interval that will call <code>function</code>
      after every <code>msecDelay</code> milliseconds have elapsed.
      It will continue to fire until you call clearInterval() with this
      interval's ID, or the page is unloaded.
      <br><br>
      Timer IDs are guaranteed to be unique values that are never reused
      within the same Timer.
    </td>
  </tr>
</table>
<table>
  <tr class="odd">
    <th colspan="2"><div align="left"><code>setInterval(fullScript, msecDelay)</code></div></th>
  </tr>
  <tr class="odd">
    <td>Parameters:</td>
    <td class="odd"><code>fullScript</code><code> <br />
      <code>msecDelay</code></td>
  </tr>
  <tr class="odd">
    <td width="113">Return value:</td>
    <td width="489">The ID of the new interval.</td>
  </tr>
  <tr class="odd">
    <td>Description:</td>
    <td class="odd">
      Creates an interval that will evaluate <code>fullScript</code>
      after every <code>msecDelay</code> milliseconds have elapsed.
      It will continue to fire until you call clearInterval() with this
      interval's ID, or the page is unloaded.
      <br><br>
      Timer IDs are guaranteed to be unique values that are never reused
      within the same Timer.
    </td>
  </tr>
</table>
<table>
  <tr class="odd">
    <th colspan="2"><div align="left"><code>clearTimeout(timeoutId)</code></div></th>
  </tr>
  <tr class="odd">
    <td>Parameters:</td>
    <td class="odd"><code>timeoutId</code>
    - The ID of the timeout to remove.
    </td>
  </tr>
  <tr class="odd">
    <td>Description:</td>
    <td class="odd">
      Works with timeouts
      created with either the <code>fullScript</code> or
      <code>function</code> version.
    </td>
  </tr>
</table>
<table>
  <tr class="odd">
    <th colspan="2"><div align="left"><code>clearInterval(intervalId)</code></div></th>
  </tr>
  <tr class="odd">
    <td>Parameters:</td>
    <td class="odd"><code>intervalId</code>
    - The ID of the interval to remove.
    </td>
  </tr>
  <tr class="odd">
    <td>Description:</td>
    <td class="odd">
      Works with intervals created with either the
      <code>fullScript</code> or <code>function</code>
      version.  No future events will fire from the given interval.  
    </td>
  </tr>
</table>


</div>
</body>
</html>
Show details Hide details

Change log

r1740 by gears.daemon on May 22, 2008   Diff 
[Author: lisbakke]

Changed Docs; added which modules cause
Gears permission dialog (LocalServer,
Database, WorkerPool only, not
HTTP/Timer/Desktop)

PRESUBMIT=passed
R=aa
CC=ggoogle-gears-eng@googlegroups.com
APPROVED=aa
DELTA=39  (15 added, 6 deleted, 18
...
Go to: 
Project members, sign in to write a code review

Older revisions

r1042 by gears.team.aa on Feb 26, 2008   Diff 
Set mimetype of all HTML files in SDK
to text/html so that they are directly
viewable from the source browser. This
isn't sticky unfortunately, so it will
need to be updated when new files are
...
r541 by gears.daemon on Dec 04, 2007   Diff 
[Author: aa]

Remove "New In 0.x" tags all over the
place and replace with a single
history.html document. I will link to
...
r403 by gears.daemon on Nov 07, 2007   Diff 
[Author: cprince]

Make the create() version parameter
optional (defaults to '1.0').
Remove the parameter from samples and
...
All revisions of this file

File info

Size: 7481 bytes, 234 lines

File properties

svn:mime-type
text/html