B2G OS

MozAlarmsManager.getAll()

This API is available on Firefox or Firefox OS for installed or higher privileged applications.

The getAll method is used to retrieve a list of pending alarms.

Syntax

var request = navigator.mozAlarms.getAll();

Return

A DOMRequest object to handle the success or failure of the method call.

If the method call is successful, the request's result will be an array of mozAlarm objects.

mozAlarm

Those objects are anonymous JavaScript objects with the following properties:

id
A number representing the id of the alarm
date
A Date object representing the scheduled time for the alarm
respectTimezone
A string indicating if the alarm must respect or ignore the timezone information of the date object. Its value can be ignoreTimezone or honorTimezone
data
A JavaScript object contaning any data that were stored with the alarm

Example

var request = navigator.mozAlarms.getAll();

request.onsuccess = function () {
  console.log('operation successful:' + this.result.length + 'alarms pending');

  this.result.forEach(function (alarm) {
    console.log(alarm.id + ' : ' + alarm.date.toString() + ' : ' + alarm.respectTimezone);    
  });
}

request.onerror = function () {
  console.log('operation failed: ' + this.error);
}

Specification

Specification Status Comment
Web Alarms API Working Draft Defines the AlarmManager interface.

Browser compatibility

Supported in Firefox OS 1.0.

This API is currently available on Firefox OS only for any installed applications. The current specification for this API is not considered stable enough to unprefix the API yet.

See also

Document Tags and Contributors

 Contributors to this page: fscholz, chrisdavidmills, teoli, Sebastianz, kscarfone, Gene, Sheppy, Jeremie
 Last updated by: fscholz,