Ações do módulo Pushwoosh para Mendix

O módulo Pushwoosh para Mendix expõe sua funcionalidade em dois lugares: o widget Pushwoosh events, que inicia o SDK e transforma notificações recebidas em eventos de nanoflow, e as ações JavaScript que você chama de qualquer nanoflow no perfil de navegação móvel nativo. Esta página lista ambos.

Propriedades do widget Pushwoosh events

O widget não renderiza nada. Coloque-o uma vez, na página que carrega primeiro no perfil de navegação móvel nativo. Ele inicializa o SDK, opcionalmente registra o dispositivo e aciona um nanoflow para cada evento de notificação push.

Setup

Estas propriedades iniciam o SDK e informam quando ele está pronto.

Propriedade	O que faz
Application Code	O Application Code da Pushwoosh do seu aplicativo, por exemplo, XXXXX-XXXXX. Obrigatório.
Register on load	Registra o dispositivo assim que o widget carrega. No iOS, isso mostra o prompt de permissão do sistema, então desative-o se preferir perguntar mais tarde com a ação RegisterForPushNotifications.
On initialized	Um nanoflow que é executado assim que o SDK é iniciado.
On registered	Um nanoflow que é executado quando o dispositivo tem um push token.
Push token	O atributo de string no qual o push token é escrito antes que On registered seja executado.

Push events

Estas propriedades entregam uma notificação recebida em seu modelo e acionam um nanoflow.

Propriedade	O que faz
Payload	O atributo de string que recebe o payload completo da notificação como JSON.
Message	O atributo de string que recebe o texto da notificação.
On push received	Um nanoflow que é executado quando uma notificação chega enquanto o aplicativo está em primeiro plano.
On push opened	Um nanoflow que é executado quando o usuário toca em uma notificação.

Deep links

Estas propriedades lidam com uma notificação que carrega um link para uma página específica do aplicativo.

Propriedade	O que faz
Deep link	O atributo de string que recebe a URL do deep link da notificação.
On deep link	Um nanoflow que é executado quando uma notificação aberta carrega um link. Ele é executado além de On push opened.

Os atributos são preenchidos antes da execução do nanoflow, para que o nanoflow possa lê-los imediatamente.

Ações de setup

Use estas ações quando você iniciar o SDK por conta própria, em vez de usar o widget.

Initialize

Inicializa o SDK da Pushwoosh. Chame-a uma vez, antes de qualquer outra ação da Pushwoosh, geralmente a partir do nanoflow de carregamento da página inicial. Você não precisa dela quando o widget Pushwoosh events está na página, porque o widget inicializa o SDK por si só.

No Android, o FCM Sender ID vem de google-services.json, que a compilação nativa utiliza. Ele não é passado para esta ação.

Parâmetro	Tipo	Descrição
applicationCode	String	O Application Code da Pushwoosh, por exemplo, XXXXX-XXXXX. Obrigatório.
notificationHandling	String	Opcional. default ou manual. Deixe em branco para o comportamento padrão.

Retorna um booleano que é verdadeiro quando o SDK foi iniciado.

Ações de registro

Estas ações controlam se este dispositivo recebe notificações e expõem os identificadores que o endereçam.

RegisterForPushNotifications

Registra o dispositivo para notificações push e retorna o push token. No iOS, isso aciona o prompt de permissão do sistema, então chame-o em um ponto do fluxo onde pedir faça sentido para o usuário.

Retorna uma String com o push token.

UnregisterForPushNotifications

Cancela o registro do dispositivo. Ele para de receber notificações até que RegisterForPushNotifications seja chamado novamente.

Retorna uma String com o token com o qual o dispositivo teve seu registro cancelado.

GetPushToken

Retorna o push token atual, ou uma string vazia se o dispositivo ainda não estiver registrado.

Retorna uma String.

GetHwid

Retorna o HWID do dispositivo, o identificador pelo qual a Pushwoosh o endereça. Use-o para direcionar um único dispositivo a partir do Control Panel da Pushwoosh ou da API do servidor.

Retorna uma String.

Ações de identidade do usuário

Estas ações conectam um dispositivo a uma pessoa, para que uma mensagem alcance todos os dispositivos que essa pessoa usa.

SetUserId

Associa o dispositivo a um usuário. Chame-a após o login.

Parâmetro	Tipo	Descrição
userId	String	Seu próprio identificador para o usuário. Obrigatório.

Retorna um booleano.

GetUserId

Retorna o User ID atualmente associado ao dispositivo, ou uma string vazia se nenhum estiver definido.

Retorna uma String.

SetEmails

Registra os endereços de e-mail do usuário na Pushwoosh, para que eles possam ser contatados por e-mail, bem como por push.

Parâmetro	Tipo	Descrição
emails	String	Um endereço, ou vários separados por vírgulas. Obrigatório.

Retorna um booleano.

Ações de Tag

Tags são as propriedades do dispositivo a partir das quais os segmentos são construídos no Control Panel da Pushwoosh.

SetTags

Define Tags no dispositivo.

Parâmetro	Tipo	Descrição
tagsJson	String	Um objeto JSON, por exemplo, {"Language":"en","Level":7,"Premium":true}. Obrigatório.

Retorna um booleano.

Aspas em expressões Mendix

Uma string em uma expressão Mendix é escrita entre aspas simples, para que o JSON dentro dela mantenha suas aspas duplas sem escape: '{"Language":"en"}'. Escrever "" ou \" dentro da expressão produz uma string que a ação não consegue analisar.

GetTags

Retorna as Tags atualmente definidas no dispositivo, como uma string JSON.

Retorna uma String.

Ações de evento

Eventos são o que inicia campanhas acionadas e mensagens in-app.

PostEvent

Publica um evento na Pushwoosh.

Parâmetro	Tipo	Descrição
eventName	String	O nome do evento conforme configurado no Control Panel. Obrigatório.
attributesJson	String	Opcional. Um objeto JSON de atributos do evento.

Retorna um booleano.

A chamada do SDK subjacente não relata sucesso nem falha, então a ação retorna verdadeiro assim que a chamada é entregue ao SDK.

Ações de notificação local

Notificações locais são produzidas pelo próprio aplicativo e não precisam de rede, o que as torna adequadas para lembretes.

ScheduleLocalNotification

Agenda uma notificação local no dispositivo.

Parâmetro	Tipo	Descrição
message	String	O texto da notificação. Obrigatório.
afterSeconds	Integer/Long	Quanto tempo esperar antes de mostrá-la, em segundos. Obrigatório, e zero ou maior.
customDataJson	String	Opcional. Um objeto JSON entregue de volta com a notificação.

Retorna um booleano assim que a chamada é entregue ao SDK. O SDK não informa se a notificação foi realmente agendada.

ClearLocalNotifications

Cancela notificações locais que foram agendadas, mas ainda não foram disparadas.

Retorna um booleano assim que a chamada é entregue ao SDK.

ClearNotificationCenter

Remove as notificações já entregues do aplicativo da central de notificações.

Retorna um booleano assim que a chamada é entregue ao SDK.

Ações de privacidade

Estas ações dão suporte a um botão de consentimento em seu aplicativo e ativam ou desativam todas as mensagens da Pushwoosh para o dispositivo.

IsCommunicationEnabled

Informa se o dispositivo tem permissão para receber comunicação da Pushwoosh no momento. Use-a para renderizar o estado de um botão de privacidade.

Retorna um booleano.

SetCommunicationEnabled

Ativa ou desativa a comunicação com a Pushwoosh para o dispositivo. Desativá-la interrompe todas as mensagens, o que a torna a ação a ser conectada a um botão “não me contate”.

Parâmetro	Tipo	Descrição
enabled	Boolean	Verdadeiro para permitir mensagens, falso para interrompê-las. Obrigatório.

Retorna um booleano.

Ações de configurações

Estas ações mudam como o SDK se comporta para este dispositivo.

SetLanguage

Substitui o idioma que a Pushwoosh usa para localizar mensagens para o dispositivo. Por padrão, o idioma do dispositivo é usado.

Parâmetro	Tipo	Descrição
language	String	Um código de duas letras como en, de, nl. Obrigatório.

Retorna um booleano assim que a chamada é entregue ao SDK.

SetReverseProxy

Roteia todo o tráfego da Pushwoosh através do seu próprio endpoint. Chame-a antes de Initialize, caso contrário, as solicitações iniciais ainda irão diretamente para a Pushwoosh.

Parâmetro	Tipo	Descrição
url	String	A URL base do proxy. Obrigatório.
headersJson	String	Opcional. Um objeto JSON de cabeçalhos HTTP extras.

Retorna um booleano assim que a chamada é entregue ao SDK.

SetShowForegroundAlert

Controla se uma notificação que chega enquanto o aplicativo está aberto é mostrada como um alerta do sistema. O padrão é ativado, então desative-o para lidar com as notificações em primeiro plano por conta própria através do evento On push received do widget.

Parâmetro	Tipo	Descrição
showAlert	Boolean	Verdadeiro para mostrar o alerta do sistema. Obrigatório.

Retorna um booleano assim que a chamada é entregue ao SDK.

Apenas iOS

O SDK do Android não expõe esta configuração, e chamar a ação no Android gera um erro. Chame-a apenas no iOS.

GetShowForegroundAlert

Informa se uma notificação que chega enquanto o aplicativo está aberto será mostrada como um alerta do sistema. Está ativado por padrão.

Retorna um booleano.

Apenas iOS

O SDK do Android não expõe esta configuração, e chamar a ação no Android gera um erro. Chame-a apenas no iOS.

Ações de outros canais

Estas ações registram o usuário para os canais de mensagens que a Pushwoosh suporta além de push.

RegisterSmsNumber

Registra o número de telefone do usuário para que a Pushwoosh possa contatá-lo por SMS.

Parâmetro	Tipo	Descrição
phoneNumber	String	Em formato internacional, por exemplo, +31201234567. Obrigatório.

Retorna um booleano assim que a chamada é entregue ao SDK.

RegisterWhatsappNumber

Registra o número de telefone do usuário para que a Pushwoosh possa contatá-lo pelo WhatsApp.

Parâmetro	Tipo	Descrição
phoneNumber	String	Em formato internacional, por exemplo, +31201234567. Obrigatório.

Retorna um booleano assim que a chamada é entregue ao SDK.