MozAlarmsManager.add()

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

Syntax

var request = navigator.mozAlarms.add(date, respectTimezone[, data]);

Properties

date

A Date object representing the time the alarm must be fired.

respectTimezone

A string that indicates if the alarm must be fired respecting the timezone set with the date. Possible values are ignoreTimezone or honorTimezone.

data Optional

An arbitrary JavaScript object with data to be stored with the alarm.

Return

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

If the method call is successfull, the request's result will be a number representing the id of the alarm.

Example

var alarm = {
  date: new Date(<code class="js string">"July 27, 2013 20:00:00"</code>),
  respectTimezone: 'ignoreTimezone',
  data: {
    message: "Do something dude!"
  }
};

var request = navigator.mozAlarms.add(alarm.date, alarm.respectTimezone, alarm.data);

request.onsuccess = function () {
  console.log('A new alarm has been set:' + this.result);
  alarm.id = this.result; // get the id of the new alarm.
}

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

Specification

Browser compatibility

[1] 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

• MozAlarmsManager
• DOMRequest