Api de Alarma

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for the proper prefixes to use in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the spec changes.

Resumen

La API de Alarma provee acceso a la configuración de alarmas del dispositivo, con la cual se puede programar una notificación o una aplicación para que se inicie en un momento específico. Por ejemplo, algunas aplicaciones, como el despertador, calendario o actualizaciones automáticas necesitan utilizar la API de alarma para activar comportamientos particulares del dispositivo en los tiempos especificados.

Por si mismo, la API de alarmas solo permite programar alarmas. Una alarma es enviada a las aplicaciones a través de la API de mensaje del sistema, entonces las aplicaciones que desean reaccionar a las alarmas tienen que registrarse en los mensajes de alarma.

Las alarmas son establecidas usando el objeto window.navigator.mozAlarms, el cual es una instancia de MozAlarmsManager.

Programar alarmas

Lo primero ha hacer cuando se utiliza alarmas es programar alarmas. Existen dos tipos de alarmas basadas respecto a la zona horaria. En ambos casos se realiza utilizando el método MozAlarmsManager.add .

Nota: Si una alarmar no es dirigida a una aplicación específica, el sistema podría enviar todas las alarmas a todas las aplicaciones que escuchan por alarmas.

Alarmas ignorando zonas horarias

Este tipo de alarmas es enviado basado en la hora local del dispositivo. Si el usuario del dispositivo cambia la zona horaria, la alarma será enviada basada en la nueva zona horaria. Por ejemplo, si un usuario se encuentra en Paris y configura una alarma que debería ser enviada a las 12 PM CET (hora de europa central) y el usuario viaja a San Francisco, la alarma será enviada a las 12 PM PDT (Hora del Pacífico).

// Esta es la fecha a programar la alarma
var myDate  = new Date("May 15, 2012 16:20:00");

// Esta es la información a pasar a la alarma
var data    = {
  foo: "bar"
}

// La cadena "ignoreTimezone" es lo que hace a la alarma ignorar esto
var request = navigator.mozAlarms.add(myDate, "ignoreTimezone", data);

request.onsuccess = function () {
  console.log("La alarma ha sido programada");
};

request.onerror = function () { 
  console.log("Ha ocurrido un error: " + this.error.name);
};

Alarmas respetando zonas horarias

Este tipo de alarmas es enviado basado en la hora en la zona horaria que se definio cuando la alarma fue programada. Si por alguna razón, el usuario del dispositivo cambia su zona horaria, la alarma será enviada basada en la zona horaria original. Por ejemplo, si un usuario se encuentra en Paris y programa una alarma que debería ser enviada a las 12 PM CET (Hora de europa central) y si el usuario viaja a San Francisco, la alarma será enviada a las 3 AM PDT (Hora del Pacífico).

// Esta es la fecha a programar la alarma
var myDate  = new Date("May 15, 2012 16:20:00");

// Esta es la información a pasar a la alarma
var data    = {
  foo: "bar"
}

// La cadena "honorTimezone" es lo que hace a la alarma respetar la zona horaria
var request = navigator.mozAlarms.add(myDate, "honorTimezone", data);

request.onsuccess = function () {
  console.log("La alarma ha sido programada");
};

request.onerror = function () { 
  console.log("Ha ocurrido un error: " + this.error.name);
};

Administrando alarmas

Una vez que uan alarma es programada, es posible administrarla.

El método MozAlarmsManager.getAll devolverá la lista completa de alarmas actualmente programadas por la aplicación. Esta lista es un Array de objetos 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("An error occurred: " + this.error.name);
};

El método MozAlarmsManager.remove se utiliza para desprogramar una alarma existente.

var alarmId;

// Set an alarm and store it's id
var request = navigator.mozAlarms.add(new Date("May 15, 2012 16:20:00"), "honorTimezone");

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

// ...

// Later on, removing the alarm if it exists
if (alarmId) {
  navigator.mozAlarms.remove(alarmId);
}

Manejando alarmas

Cualquier aplicación puede reaccionar cuando una alarma es programada por el sistema. Con el fin de ser capaz de manejar alarmas, una aplicación debe registrarse como manejador de alarmas. Esto se logra a través del API de mensajes del sistema en dos pasos:

Primero, las aplicaciones deberán incluir alarm en la propiedad de mensajes en el manifiesto de su aplicación con la URL del documento que registra la función de retorno (callback) ha ser usada cuando la alarma sea enviada.

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

Segundo,  la aplicación debe enlazar la función de retorno (callback) con el mensaje de alarm.

Esto se logra usando el método navigator.mozSetMessageHandler . Esta función recibirá el objeto mozAlarm conteniendo la información agregada a la alarma.

navigator.mozSetMessageHandler("alarm", function (mozAlarm) { 
  alert("alarm fired: " + JSON.stringify(mozAlarm.data)); 
});

Si una aplicación desea saber si existe una alarma pendiente a nivel del sistema, es posible utilizar el método navigator.mozHasPendingMessage con el valor alarm.

navigator.mozHasPendingMessage("alarm"); 

Especificaciones

Especificación Estado Comentario
Web Alarms API Working Draft Especificación inicial.

Compatibilidad de navegadores

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support ? 16 (16) moz Not supported Not supported Not supported
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support ? Not supported 10.0 (10) moz Not supported Not supported Not supported

Ver también

Etiquetas y colaboradores del documento

 Colaboradores en esta página: ccarruitero
 Última actualización por: ccarruitero,