Acciones del módulo Pushwoosh para Mendix

El módulo de Pushwoosh para Mendix expone su funcionalidad en dos lugares: el widget Eventos de Pushwoosh, que inicia el SDK y convierte las notificaciones entrantes en eventos de nanoflujo, y las acciones de JavaScript que usted llama desde cualquier nanoflujo en el perfil de navegación móvil nativo. Esta página enumera ambos.

Propiedades del widget de eventos de Pushwoosh

El widget no renderiza nada. Colóquelo una vez, en la página que se carga primero en el perfil de navegación móvil nativo. Inicializa el SDK, opcionalmente registra el dispositivo y activa un nanoflujo para cada evento de notificación push.

Configuración

Estas propiedades inician el SDK e informan cuando está listo.

Propiedad	Qué hace
Código de la aplicación	El Código de Aplicación de Pushwoosh de su app, por ejemplo XXXXX-XXXXX. Requerido.
Registrar al cargar	Registra el dispositivo tan pronto como se carga el widget. En iOS, esto muestra el aviso de permisos del sistema, así que desactívelo si prefiere preguntar más tarde con la acción RegisterForPushNotifications.
Al inicializar	Un nanoflujo que se ejecuta una vez que el SDK se ha iniciado.
Al registrar	Un nanoflujo que se ejecuta cuando el dispositivo tiene un token de push.
Token de push	El atributo de cadena en el que se escribe el token de push antes de que se ejecute Al registrar.

Eventos de push

Estas propiedades entregan una notificación entrante a su modelo y activan un nanoflujo.

Propiedad	Qué hace
Payload	El atributo de cadena que recibe el payload completo de la notificación como JSON.
Mensaje	El atributo de cadena que recibe el texto de la notificación.
Al recibir push	Un nanoflujo que se ejecuta cuando llega una notificación mientras la app está en primer plano.
Al abrir push	Un nanoflujo que se ejecuta cuando el usuario toca una notificación.

Enlaces profundos

Estas propiedades manejan una notificación que lleva un enlace a una página específica de la app.

Propiedad	Qué hace
Enlace profundo	El atributo de cadena que recibe la URL del enlace profundo de la notificación.
Al usar enlace profundo	Un nanoflujo que se ejecuta cuando una notificación abierta contiene un enlace. Se ejecuta además de Al abrir push.

Los atributos se rellenan antes de que se ejecute el nanoflujo, por lo que el nanoflujo puede leerlos de inmediato.

Acciones de configuración

Use estas acciones cuando inicie el SDK usted mismo en lugar de usar el widget.

Initialize

Inicializa el SDK de Pushwoosh. Llámelo una vez, antes de cualquier otra acción de Pushwoosh, típicamente desde el nanoflujo de carga de la página de inicio. No lo necesita cuando el widget Eventos de Pushwoosh está en la página, porque el widget inicializa el SDK por sí mismo.

En Android, el ID de remitente de FCM proviene de google-services.json, que la compilación nativa recoge. No se pasa a esta acción.

Parámetro	Tipo	Descripción
applicationCode	String	El Código de Aplicación de Pushwoosh, por ejemplo XXXXX-XXXXX. Requerido.
notificationHandling	String	Opcional. default o manual. Déjelo vacío para el comportamiento predeterminado.

Devuelve un booleano que es verdadero cuando el SDK se ha iniciado.

Acciones de registro

Estas acciones controlan si este dispositivo recibe notificaciones y exponen los identificadores que se dirigen a él.

RegisterForPushNotifications

Registra el dispositivo para notificaciones push y devuelve el token de push. En iOS, esto activa el aviso de permisos del sistema, así que llámelo en un punto del flujo donde preguntar tenga sentido para el usuario.

Devuelve una cadena con el token de push.

UnregisterForPushNotifications

Anula el registro del dispositivo. Deja de recibir notificaciones hasta que se vuelva a llamar a RegisterForPushNotifications.

Devuelve una cadena con el token con el que se anuló el registro del dispositivo.

GetPushToken

Devuelve el token de push actual, o una cadena vacía si el dispositivo aún no está registrado.

Devuelve una cadena.

GetHwid

Devuelve el HWID del dispositivo, el identificador con el que Pushwoosh se dirige a él. Úselo para dirigirse a un único dispositivo desde el Panel de Control de Pushwoosh o la API del servidor.

Devuelve una cadena.

Acciones de identidad de usuario

Estas acciones conectan un dispositivo a una persona, para que un mensaje llegue a cada dispositivo que esa persona utiliza.

SetUserId

Asocia el dispositivo con un usuario. Llámelo después de iniciar sesión.

Parámetro	Tipo	Descripción
userId	String	Su propio identificador para el usuario. Requerido.

Devuelve un booleano.

GetUserId

Devuelve el ID de usuario actualmente asociado con el dispositivo, o una cadena vacía si no se ha establecido ninguno.

Devuelve una cadena.

SetEmails

Registra las direcciones de correo electrónico del usuario en Pushwoosh, para que puedan ser contactados por correo electrónico además de por push.

Parámetro	Tipo	Descripción
emails	String	Una dirección, o varias separadas por comas. Requerido.

Devuelve un booleano.

Acciones de etiquetas

Las etiquetas son las propiedades del dispositivo a partir de las cuales se construyen los segmentos en el Panel de Control de Pushwoosh.

SetTags

Establece etiquetas en el dispositivo.

Parámetro	Tipo	Descripción
tagsJson	String	Un objeto JSON, por ejemplo {"Language":"en","Level":7,"Premium":true}. Requerido.

Devuelve un booleano.

Comillas en expresiones de Mendix

Una cadena en una expresión de Mendix se escribe entre comillas simples, por lo que el JSON dentro de ella mantiene sus comillas dobles sin escapar: '{"Language":"en"}'. Escribir "" o \" dentro de la expresión produce una cadena que la acción no puede analizar.

GetTags

Devuelve las etiquetas actualmente establecidas en el dispositivo, como una cadena JSON.

Devuelve una cadena.

Acciones de eventos

Los eventos son desde donde se inician las campañas activadas y los mensajes in-app.

PostEvent

Publica un evento en Pushwoosh.

Parámetro	Tipo	Descripción
eventName	String	El nombre del evento tal como se configuró en el Panel de Control. Requerido.
attributesJson	String	Opcional. Un objeto JSON de atributos del evento.

Devuelve un booleano.

La llamada subyacente al SDK no informa de éxito ni de fracaso, por lo que la acción devuelve verdadero tan pronto como la llamada ha sido entregada al SDK.

Acciones de notificación local

Las notificaciones locales son producidas por la propia app y no necesitan red, lo que las hace adecuadas para recordatorios.

ScheduleLocalNotification

Programa una notificación local en el dispositivo.

Parámetro	Tipo	Descripción
message	String	El texto de la notificación. Requerido.
afterSeconds	Integer/Long	Cuánto tiempo esperar antes de mostrarla, en segundos. Requerido, y cero o mayor.
customDataJson	String	Opcional. Un objeto JSON que se devuelve con la notificación.

Devuelve un booleano tan pronto como la llamada ha sido entregada al SDK. El SDK no informa si la notificación fue realmente programada.

ClearLocalNotifications

Cancela las notificaciones locales que se programaron pero que aún no se han disparado.

Devuelve un booleano tan pronto como la llamada ha sido entregada al SDK.

ClearNotificationCenter

Elimina las notificaciones ya entregadas de la app del centro de notificaciones.

Devuelve un booleano tan pronto como la llamada ha sido entregada al SDK.

Acciones de privacidad

Estas acciones respaldan un interruptor de consentimiento en su app y activan o desactivan toda la mensajería de Pushwoosh para el dispositivo.

IsCommunicationEnabled

Indica si el dispositivo tiene permitido actualmente recibir comunicación de Pushwoosh. Úselo para representar el estado de un interruptor de privacidad.

Devuelve un booleano.

SetCommunicationEnabled

Activa o desactiva la comunicación con Pushwoosh para el dispositivo. Desactivarla detiene toda la mensajería, lo que la convierte en la acción a conectar a un interruptor de “no contactarme”.

Parámetro	Tipo	Descripción
enabled	Boolean	Verdadero para permitir la mensajería, falso para detenerla. Requerido.

Devuelve un booleano.

Acciones de configuración

Estas acciones cambian cómo se comporta el SDK para este dispositivo.

SetLanguage

Sobrescribe el idioma que Pushwoosh utiliza para localizar los mensajes para el dispositivo. Por defecto, se utiliza el idioma del dispositivo.

Parámetro	Tipo	Descripción
language	String	Un código de dos letras como en, de, nl. Requerido.

Devuelve un booleano tan pronto como la llamada ha sido entregada al SDK.

SetReverseProxy

Enruta todo el tráfico de Pushwoosh a través de su propio punto final. Llámelo antes de Initialize, de lo contrario, las solicitudes iniciales seguirán yendo directamente a Pushwoosh.

Parámetro	Tipo	Descripción
url	String	La URL base del proxy. Requerido.
headersJson	String	Opcional. Un objeto JSON de cabeceras HTTP adicionales.

Devuelve un booleano tan pronto como la llamada ha sido entregada al SDK.

SetShowForegroundAlert

Controla si una notificación que llega mientras la app está abierta se muestra como una alerta del sistema. El valor predeterminado es activado, así que desactívelo para manejar las notificaciones en primer plano usted mismo a través del evento Al recibir push del widget.

Parámetro	Tipo	Descripción
showAlert	Boolean	Verdadero para mostrar la alerta del sistema. Requerido.

Devuelve un booleano tan pronto como la llamada ha sido entregada al SDK.

Solo para iOS

El SDK de Android no expone esta configuración, y llamar a la acción en Android genera un error. Llámelo solo en iOS.

GetShowForegroundAlert

Indica si una notificación que llega mientras la app está abierta se mostrará como una alerta del sistema. Está activado por defecto.

Devuelve un booleano.

Solo para iOS

El SDK de Android no expone esta configuración, y llamar a la acción en Android genera un error. Llámelo solo en iOS.

Acciones de otros canales

Estas acciones registran al usuario para los canales de mensajería que Pushwoosh admite más allá del push.

RegisterSmsNumber

Registra el número de teléfono del usuario para que Pushwoosh pueda contactarlo por SMS.

Parámetro	Tipo	Descripción
phoneNumber	String	En formato internacional, por ejemplo +31201234567. Requerido.

Devuelve un booleano tan pronto como la llamada ha sido entregada al SDK.

RegisterWhatsappNumber

Registra el número de teléfono del usuario para que Pushwoosh pueda contactarlo por WhatsApp.

Parámetro	Tipo	Descripción
phoneNumber	String	En formato internacional, por ejemplo +31201234567. Requerido.

Devuelve un booleano tan pronto como la llamada ha sido entregada al SDK.