Alarm API

Résumé

L'API Alarm permet d'accéder aux paramètres d'alarme de l'appareil, qui peuvent planifier une notification ou le lancement d'une application à un moment précis. Par exemple, certaines applications comme le radio-réveil, le calendrier ou ou encore la mise à jour automatique peuvent devoir utiliser l'API Alarm pour déclencher des comportements de périphérique particulier à des moments spécifiés.

Les alarmes sont réglées en utilisant l'objet window.navigator.mozAlarms qui est une instance de l'interface MozAlarmsManager.

Programmer des alarmes

Alarmes ignorant les fuseaux horaires

// Ceci est la date de planification de l'alarme
var myDate  = new Date("May 15, 2012 16:20:00");

// Les données arbitraires passées à l'alarme
var data    = {
  foo: "bar"
}

// La chaîne "ignoreTimezone" est se qui permet d'ignorer le fuseau horaire
var request = navigator.mozAlarms.add(myDate, "ignoreTimezone", data);

request.onsuccess = function () {
  console.log("L'alarme a été déclanchée");
};

request.onerror = function () { 
  console.log("Une erreur s'est produite : " + this.error.name);
};

Alarmes respectant les fuseaux horaires

// Ceci est la date de planification de l'alarme
var myDate  = new Date("May 15, 2012 16:20:00");

// Les données arbitraires passées à l'alarme
var data    = {
  foo: "bar"
}

// La chaîne "honorTimezone" est se qui permet de garder le fuseau horaire
var request = navigator.mozAlarms.add(myDate, "honorTimezone", data);

request.onsuccess = function () {
  console.log("L'alarme a été déclanchée");
};

request.onerror = function () { 
  console.log("Une erreur s'est produite : " + this.error.name);
};

Gérer les alarmes

La méthode  MozAlarmsManager.getAll va retourner la liste complète des alarmes programmées par l'application. Cette liste est un Array d'objets mozAlarm.

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

var request = navigator.mozAlarms.getAll();

request.onsuccess = function () {
  this.result.forEach(function (alarm) {
    console.log('Id: ' + alarm.id);
    console.log('date: ' + alarm.date);
    console.log('respectTimezone: ' + alarm.respectTimezone);
    console.log('data: ' + JSON.stringify(alarm.data));
  });
};

request.onerror = function () { 
  console.log("Une erreur s'est produite : " + this.error.name);
};

La méthode MozAlarmsManager.remove est utilisée pour dé-programmer une alarme existante.

var alarmId;

// Programme une alarme est stocke son id
var request = navigator.mozAlarms.add(new Date("May 15, 2012 16:20:00"), "honorTimezone");

request.onsuccess = function () {
  alarmId = this.result;
}

// ...

// Plus tard, on retire l'alarme si elle existe
if (alarmId) {
  navigator.mozAlarms.remove(alarmId);
}

Manipuler les alarmes

Tout d'abord, les applications doivent inclure alarm au messages property of its application manifest avec l'URL du document qui enregistre la fonction de rappel à utiliser lorsqu'une alarme est envoyée.

"messages": [
  { "alarm": "/index.html" }
]

Pour finir, l'application doit lier une fonction de rappel avec le message d'alarme. Cela se fait à l'aide de la méthode navigator.mozSetMessageHandler . Cette fonction de rappel va recevoir un objet mozAlarm contenant les données associées à l'alarme.

navigator.mozSetMessageHandler("alarm", function (mozAlarm) { 
  alert("alarme déclanchée : " + JSON.stringify(mozAlarm.data)); 
});

navigator.mozHasPendingMessage("alarm"); 

Spécifications

Compatibilité des navigateurs

Voir aussi

• navigator.mozAlarms
• MozAlarmsManager
• window.navigator.mozSetMessageHandler