Revision 711285 of timers

Revision slug: Mozilla/Add-ons/SDK/High-Level_APIs/timers
Revision title: timers
Revision id: 711285
Created: Dec 21, 2014, 3:00:01 PM
Creator: wbamberg
Is current revision? No
Comment

Tags:

Add-on SDK

Revision Content

Stable

Set one-off and periodic timers.

Globals

Constructors

Functions

`setTimeout(callback, ms)`

Schedules callback to be called in ms milliseconds. Any additional arguments are passed straight through to the callback.

Parameters

callback : function
Function to be called.

ms : integer
Interval in milliseconds after which the function will be called.

Returns

integer : An ID that can later be used to undo this scheduling, if callback hasn't yet been called.

`clearTimeout(ID)`

Given an ID returned from setTimeout(), prevents the callback with the ID from being called (if it hasn't yet been called).

Parameters

ID : integer
An ID returned from setTimeout().

`setInterval(callback, ms)`

Schedules callback to be called repeatedly every ms milliseconds. Any additional arguments are passed straight through to the callback.

Parameters

callback : function
Function to be called.

ms : integer
Interval in milliseconds at which the function will be called.

Returns

integer : An ID that can later be used to unschedule the callback.

`clearInterval(ID)`

Given an ID returned from setInterval(), prevents the callback with the ID from being called again.

Parameters

ID : integer
An ID returned from setInterval().

Revision Source

<div class="note">
 <p>Stable</p>
</div>
<p><span class="seoSummary">Set one-off and periodic timers.</span></p>
<h2 id="Globals">Globals</h2>
<h3 id="Constructors">Constructors</h3>
<h3 id="Functions">Functions</h3>
<h4 class="addon-sdk-api-name" id="setTimeout(callback.2C_ms)"><code>setTimeout(callback, ms)</code></h4>
<p>Schedules <code>callback</code> to be called in <code>ms</code> milliseconds. Any additional arguments are passed straight through to the callback.</p>
<h5 id="Parameters">Parameters</h5>
<p><strong>callback : function</strong><br />
 Function to be called.</p>
<p><strong>ms : integer</strong><br />
 Interval in milliseconds after which the function will be called.</p>
<h5 id="Returns">Returns</h5>
<p><strong>integer</strong> : An ID that can later be used to undo this scheduling, if <code>callback</code> hasn't yet been called.</p>
<h4 class="addon-sdk-api-name" id="clearTimeout(ID)"><code>clearTimeout(ID)</code></h4>
<p>Given an ID returned from <code>setTimeout()</code>, prevents the callback with the ID from being called (if it hasn't yet been called).</p>
<h5 id="Parameters_2">Parameters</h5>
<p><strong>ID : integer</strong><br />
 An ID returned from <code>setTimeout()</code>.</p>
<h4 class="addon-sdk-api-name" id="setInterval(callback.2C_ms)"><code>setInterval(callback, ms)</code></h4>
<p>Schedules <code>callback</code> to be called repeatedly every <code>ms</code> milliseconds. Any additional arguments are passed straight through to the callback.</p>
<h5 id="Parameters_3">Parameters</h5>
<p><strong>callback : function</strong><br />
 Function to be called.</p>
<p><strong>ms : integer</strong><br />
 Interval in milliseconds at which the function will be called.</p>
<h5 id="Returns_2">Returns</h5>
<p><strong>integer</strong> : An ID that can later be used to unschedule the callback.</p>
<h4 class="addon-sdk-api-name" id="clearInterval(ID)"><code>clearInterval(ID)</code></h4>
<p>Given an ID returned from <code>setInterval()</code>, prevents the callback with the ID from being called again.</p>
<h5 id="Parameters_4">Parameters</h5>
<p><strong>ID : integer</strong><br />
 An ID returned from <code>setInterval()</code>.</p>

Revert to this revision