Phonegap/Cordova y las Notificaciones Push

15
44507

Phonegap/Cordova y las Notificaciones Push.

 

0. Índice de contenidos.

1. Introducción

Las Notificaciones Push son un mecanismo del que disponen las aplicaciones móviles para poder recibir avisos emitidos por un sistema en cualquier momento siempre que el dispositivo no esté apagado. Las herramientas de trabajo colaborativo, de mensajería, los sistemas de monitorización, redes sociales… son algunos ejemplos de aplicaciones que hacen uso de esta característica.

Las Notificaciones Push son una funcionalidad nativa del dispositivo, por lo que si queremos hacer uso de ella deberemos desarrollar una aplicación haciendo uso de una tecnología nativa (Android, IOS…) o cross-platform (Phonegap, Titanium…).

En este tutorial intentaremos explicar mediante un ejemplo cómo funcionan las Notificaciones Push en una aplicación móvil híbrida desarrollada con Apache Cordova para dispositivos Android.

2. Entorno.

El tutorial está escrito usando el siguiente entorno:

  • Hardware: Portátil MacBook Pro 15′ (2.2 Ghz Intel Core I7, 8GB DDR3).
  • Sistema Operativo: Mac OS X Mavericks 10.9
  • NetBeans IDE 8.0
  • Genymotion 2.2.2
  • Apache Cordova 3.4.1
  • Ionic Framework 1.0.0-beta.9
  • Google Cloud Messaging REST Service desplegado en Apache Tomcat 7
  • Dispositivos:
    • Samsung Galaxy R (I9103): Android 4.0.4
    • Samsung Galaxy Core: Android 4.1.2
    • Samsung Galaxy Tab: Android 4.0.4
    • Samsung Galaxy S3 Mini: Android 4.1.2

3. ¿Qué vamos a hacer?.

Haremos una pequeña aplicación móvil híbrida para Android con ayuda de Apache Cordova (si alguien no se ha enterado de nada de lo anterior lo mejor es que pare de leer y le eche un ojo a este tutorial de mi compi Rubén). Nuestra aplicación será capaz de recibir Notificaciones Push desde Google Cloud Messaging. Los requisitos serán los siguientes:

  • Las notificaciones podrán ser enviadas a cualquier dispositivo que tenga instalada la aplicación desde cualquier punto de nuestro sistema.
  • El usuario de la aplicación debe poder recibir notificaciones en los siguientes casos:
    • El usuario está utilizando la aplicación.
    • La aplicación está corriendo en un segundo plano.
    • La aplicación no se arrancó.
    • El dispositivo está en reposo (pantalla apagada).

Para poder conseguir todo esto, además de hacer uso de Apache Cordova, necesitaremos hacer uso del plugin de Phonegap para Notificaciones Push.

4. El plugin de Phonegap para las Notificaciones Push.

Existen diversos plugins de Phonegap/Cordova para Notificaciones Push. Nosotros hemos elegido este por su popularidad y facilidad de uso.

El plugin no da únicamente soporte a la recepción de notificaciones en Android, sino también a IOS, Windows Phone 8 y Amazon Fire OS. Cada uno recibirá mensajes de sus respectivos servicios en la nube (cada fabricante tiene uno).

El plugin se puede instalar, para cada una de las plataformas, tanto de manera automática como manual. Nosotros por sencillez elegiremos la manera automática (lo veremos en el siguiente punto) que realmente lo que hace es añadir los ficheros nativos al proyecto (.java ya que estamos en Android), definir los permisos necesarios, actividades y servicios. Requisitos necesarios para recibir Notificaciones Push desde Google Cloud Messaging tal y como vimos en el anterior tutorial.

5. Creando nuestra aplicación.

Ya vale de teoría, vamos a meternos en el código 🙂

5.1 Configuración inicial.

Lo primero que haremos será crear el esqueleto de nuestro proyecto. Para ello, en el directorio deseado ejecutamos el siguiente comando:

Donde:

  • . (punto): El directorio donde queremos crear el proyecto, en nuestro caso en el directorio actual.
  • com.autentia.phonegap.pushnotifications: Identificador de nuestra aplicación (tipo dominio inverso).
  • PhonegapPush: El nombre de nuestra aplicación.

Nos creará algo como esto.

Project structure

Añadimos la plataforma destino de nuestra aplicación. En nuestro caso Android.

Añadimos el plugin de Phonegap que vimos en el punto anterior para recibir Notificaciones Push (instalación automática).

Añadimos el plugin de Cordova para conocer el estado de nuestra conexión. Este plugin es opcional pero nos viene muy bien ya que si nuestro dispositivo no tiene salida a Internet no podremos recibir notificaciones desde GCM.

Añadimos el plugin de Cordova para conocer información relativa al dispositivo. Igualmente es opcional. En nuestro caso queremos saber si el sistema operativo es Android.

Por último, en nuestro fichero /www/index.html nos aseguramos de que tenemos importada la librería de Javascript de Cordova (cordova.js) y la del plugin de Notificaciones Push (PushNotification.js).

Además utilizaremos un poco de jQuery para que nos facilite un poco el trabajo.

5.2 Registrando el dispositivo en Google Cloud Messaging.

Una vez tenemos la configuración inicial, ya podemos empezar con el código de nuestra aplicación. Lo primero que haremos será registrar nuestro dispositivo en el servicio de Google Cloud Messaging. Si el registro se realizó de manera correcta, obtendremos un identificador de registro (registration ID) tal y como se puede ver en los pasos 1 y 2 del siguiente diagrama.

Device registration

Para ello crearemos una función register que, haciendo uso del la librería javascript que nos proporciona el plugin de Phonegap para Notificaciones Push, nos permitirá poder realizar el registro en GCM (líneas 2 y 5 del siguiente fragmento de código). Además, en el proceso de registro, necesitaremos suministrar dos parámetros (líneas 10 y 11):

  • senderID: Número de proyecto en Google Cloud Console. Número de proyecto del que ya hablamos y vimos cómo obtener en el anterior tutorial
  • ecb: Nombre de la función a la que el plugin de Notificaciones Push invocará cada vez que reciba un evento desde Google Cloud Messaging. Dicho evento puede ser una confirmación de registro (registrationID desde GCM), una notificación o un error. OJO!!! No puede ser una función de callback, tiene que ser el nombre de la función.

Lo siguiente que haremos será implementar la función onNotificationGCM que es el nombre que dimos en el fragmento anterior a la función que manejará las notificaciones que nos lleguen desde GCM.

Podemos apreciar que cuando el valor de la propiedad event del evento que recibimos es registered significa que nos hemos registrado en GCM y que éste nos devuelve un identificador de registro (registration ID). Hasta aquí sería lo relativo al los pasos 1 y 2 del anterior diagrama. Con dicho identificador nos registraremos en nuestro servicio (paso 3 del diagrama). Lo vemos en el punto siguiente.

5.3 Registrando el dispositivo en nuestro servidor.

Para que esté totalmente completado el proceso de registro del anterior diagrama, necesitaremos registrar nuestro dispositivo en nuestro servidor propio. Tan sencillo como enviar una petición HTTP por POST con nuestro identificador de registro (registrationId) que acabamos de recibir de GCM. Él ya se encarga de todo :).

En el log del servidor podremos ver el identificador del registro.

Registration log

Pues ya estamos registrados, a partir de este punto ya podríamos recibir notificaciones…

5.4 Enviando una notificación.

Ya estamos listos para enviar una notificacion, del mismo modo que hicimos en el punto anterior, aprovecharemos nuestro servicio para realizar dicha tarea.

Muy sencillo, desde cualquier punto de nuestro sistema desde el que tengamos acceso al servidor enviamos una petición como la que se ve a continuación:

Donde:

  • badge: es un número que aparece en la parte derecha de nuestra notificación (lo veremos más abajo). Intenta simular el número de notificaciones que el usuario tiene pendientes de leer.
  • title: el título del mensaje de nuestra notificación.
  • message: el cuerpo del mensaje.
  • registrationIdsToSend: array con identificadores de registro a los que enviar la notificación. Dichos identificadores deben antes haber sido registrados en nuestro servicio tal y como vimos en el punto anterior.

5.5 Manejando la notificación.

Y lo último que nos queda es manejar la notificación. Para ello, en la función onNotificationGCM que vimos en punto 5.2 y que era la responsable de manejar las notificaciones que nos llegasen desde GCM, añadimos la lógica necesaria para procesar el mensaje propio de la notificación.

Dentro de la información de la notificación podremos saber el estado de la aplicación al recibir el mensaje (por si queremos manejarlo de diferentes formas):

  • foreground: cuando el usuario está utilizando la aplicaicón.
  • coldstart: cuando la aplicación estaba en un segundo plano.
  • todo lo demás: la aplicación arranca por primera vez.

6. El resultado final.

Pues utilizando como base todo esto que hemos explicado, un poco de AngularJS y una pizca de Ionic (un excelente framework HTML5 para desarrollar aplicaciones móviles híbridas) ya tendríamos nuestra aplicación lista para recibir Notificaciones Push desde Google Cloud Messaging :D.

La aplicación arranca y comprueba que tenemos acceso a Internet, se registra en Google Cloud Messaging y en nuestro servidor.

Si cerramos o minimizamos nuestra aplicación, incluso si ni siquiera la hubiésemos arrancado o si el móvil estuviese en reposo, al recibir una notificación nos aparecerá el icono de la aplicación indicando que tenemos una nueva notificación.

Desplegando el menú de opciones vemos más en detalle nuestra notificación. El 1 que se ve en la parte derecha es el parámetro badge que enviamos en el punto anterior.

Si pulsamos sobre la propia notificación, se abrirá la aplicación y nos saltará un mensaje con el texto y el título. Si estuviésemos utilizando la aplicación (foreground) y nos llegase otra, nos saltaría de nuevo el mensaje pero no nos aparecerá el icono de la parte superior.

AQUÍ OS DEJO TODO EL CÓDIGO FUENTE DE LA APLICACIÓN

7. Referencias.

8. Conclusiones.

En este tutorial hemos visto cómo utilizar el plugin de Notificaciones Push que nos proporciona Phonegap para crear una aplicación híbrida (corre en un webview) que, interactuando de manera nativa con el dispositivo, pueda ser capaz de recibir notificaciones en cualquier momento desde Google Cloud Messaging.

El desarrollo híbrido o cross-platform en términos de movilidad puede tener algunas desventajas con respecto al desarrollo nativo pero también tiene muchas otras ventajas. Desde luego, la recepción de notificaciones remotas ya no será un problema si utilizamos un framework como Apache Cordova (o incluso otros como Titanium, pero ese es otro tema…).

Cualquier duda en la sección de comentarios.

Espero que este tutorial os haya sido de ayuda. Un saludo.

Miguel Arlandy

marlandy@autentia.com

Twitter: @m_arlandy

15 Comentarios

  1. Hola, estoy con un problema. Tengo desarrollada una app de notificaciones pero quiero guardar en un localStorage la notificación para tener un historial de las que ingresaron. Se puede hacer eso?? es por medio del centro de notificaciones? La idea es desplegar el listado de las notificaciones cuando el usuario este dentro de la app.

    Gracias.

  2. Hola una consulta…. este tutorial se podría aplicar a intel xdk?? necesito un poco de ayuda ando medio perdido >_>, me sumo al comentario de arriba…

  3. Hola,

    Muchas gracias por el tutorial, tengo una traba y es que quiero que un dispositvo mande la notificacion a otro dispositivo. Como si fuera un chat.
    Para eso tendria que implementar una app cliente y servidor?
    o
    Un cliente que envie peticiones al servidor, que al final van a ser indicaciones al servidor para que haga un push?

    gracias
    un saludo

  4. Saludos, hice todo lo del tuto , pero en la linea
    var pushNotification = window.plugins.pushNotification;
    me dice que la variable pushNotification es indefinida.
    Ayuda por favor.

  5. Hola, soy nuevo con Cordova,
    me podrías explicar bien como esto

    url: “http://3rd_PARTY_SERVER_HOST:PORT/gcm-rest/api/registrations”, /* Your gcm-rest registration endpoint */ ?

    que deberia ir con exactitud en 3rd_PARTY_SERVER_HOST:PORT/
    y como lo genero.?
    Gracias

  6. […] La web de origen del tutorial es “adictosaltrabajo” y su título es Phonegap/Cordova y las Notificaciones Push | adictosaltrabajo. […]

Dejar respuesta

Please enter your comment!
Please enter your name here