Clases principales

3. Clases principales

Mensaje 

Engloba toda la información necesaria para el envío de la notificación push.


MensajeRich 

Engloba toda la información necesaria para el envío de la notificación rich.


MenConflos

Sirve para la configuración de los mensajes para iOS.


MenConAnd

Sirve para la configuración de los mensajes para Android.


ContMensaje

Contiene el contenido de un mensaje push.


ContMensajerich

Contiene el contenido de un mensaje rich.


Mensaje Parámetros

Se utiliza para incluir parámetros en la notificación. Se crean con el formato clave-valor.


Respuesta mensaje

Utilizado para enviar una respuesta al dispositivo. Para crear la respuesta utilizaremos:

public RespuestaMensaje (DispositivoMensaje dispositivoMensaje, String codigoError, String descripcionError);

Dispositivo 

Engloba toda la información necesaria del dispositivo. Para la creación del dispositivo utilizaremos:

public Dispositivo(String idUsuario, int tipoDisp, String idDispositivo, String idNotificacion, boolean migradoFCM, boolean migradoApple);

DispositivoMensaje

Sirve para obtener el dispositivo al que va dirigido el mensaje. Si en el mensaje se ha seleccionado la opción broadcast, la lista de dispositivos será nula.

MensajePreferencias

Se utiliza para incluir preferencias en el envío de la notificación. Se utilizarán los segmentos para el uso de esta entidad.


Octopush

Es la clase más importante. Sirve para enviar las notificaciones. Posee los siguientes métodos:

public OctopushImpl():

 Constructor vacío.

public Respuesta sendPush(Mensaje mensaje) throws OctopushException: 
 Envía un único mensaje push.

public Respuesta sendPushList(List<Mensaje> mensaje) throws OctopushException:
 
 Envía una lista de mensajes push.

public Respuesta cancelSend(String claveAplicacion, String codigo) throws OctopushException: 
 Cancela el envío de una notificación push programada. El parámetro código es el código identificador único de la notificación push programada.


public Respuesta sendRich(Mensaje mensaje) throws OctopushException: 
 Envía un único mensaje rich.

 public Respuesta sendRichList(List<Mensaje> mensaje) throws OctopushException:
 
 Envía una lista de mensajes rich.


 public Respuesta<Dispositivo> getRegisteredDevices(String claveApp, Integer tipo) throws OctopushException:
 
 Devuelve el listado de dispositivos de la plataforma. En el tipo se indica si los dispositivos tienen un usuario registrado o si son anónimos.
    1.- Todas       => Constantes.TIPO_TODOS
    2.- Anónimos    => Constantes.TIPO_ANONIMO
    3.- Registrados => Constantes.TIPO_REGISTRADO

public Respuesta<Dispositivo> getDevicesByUser(String claveApp, String idUsuario) throws OctopushException:
 
 Devuelve el listado de dispositivos de la plataforma asociados al usuario registrado que se indica como parámetro.

Nota: Si la notificación es muy grande (más de 150 caracteres), no se producirá el envío.

 

Clases principales