Ações de cliente do plugin Pushwoosh para Outsystems

O Plugin fornece um conjunto de ações de cliente para facilitar o gerenciamento de notificações push. Essas ações permitem registrar e cancelar o registro de dispositivos, definir e obter tags, gerenciar mensagens da caixa de entrada e muito mais.

Ações de cliente do plugin Pushwoosh

CheckPushwooshPlugin

Valida se o plugin Pushwoosh está atualmente disponível.

Parâmetros de saída

IsAvailable	Retorna verdadeiro se o plugin estiver disponível para uso, caso contrário, falso
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

Exemplo de uso

RegisterDevice

Registra um dispositivo para notificações push e obtém um Token de Push.

Parâmetros de entrada

ApplicationCode	Texto, o código da aplicação Pushwoosh obtido nas configurações da sua conta.

Parâmetros de saída

RegisterToken	Token recebido do Google ou da Apple para o dispositivo
Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

UnregisterDevice

Cancela o registro de um dispositivo para o recebimento de notificações push.

Parâmetros de saída

Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

GetDeviceID

Obtém o ID do dispositivo, que deve ser um identificador único.

Parâmetros de saída

DeviceHwid	O identificador único do dispositivo.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando houve um erro.

GetDeviceType

Obtém o Tipo de Dispositivo (Android, iOS ou Windows).

Parâmetros de saída

DeviceTypeId	O identificador deste tipo de dispositivo.

GetTags

Busca dados de tags do Pushwoosh.

Parâmetros de saída

Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.
Tags	Retorna uma Lista de Registros de Chave e Valor contendo todas as tags atribuídas a este dispositivo.

Exemplo de uso

1. Invoque a ação GetTags para buscar os dados das tags do Pushwoosh.
2. As tags retornadas são acessíveis através da lista GetTags.Tags.

3. Use a ação LogMessage para registrar a chave e o valor de cada tag.

PostEvent

Envia uma mensagem para o Pushwoosh quando um evento específico ocorre em sua aplicação.

Parâmetros de entrada

EventName	Texto, nome do evento
EventAttributes	Lista de Registros de Chave e Valor, usada para enviar dados de eventos adicionais para o Pushwoosh (por exemplo, para a ação “UserLogin”, você pode querer enviar dados de login, como - {"username":"John"})

Parâmetros de saída

Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

Exemplo de uso

1. Atribuir

Configure pares de chave-valor para definir os dados para o evento. Por exemplo, KeyValue1.AttributeName como “test1” e KeyValue1.Value como “test1value”. Da mesma forma, defina KeyValue2 com o nome e o valor do atributo apropriados.

2. Crie listas de atributos a serem associados ao evento.

3. Finalmente, configure a ação PostEvent.

SetBadgeNumber

Define o número do selo do ícone da aplicação.

Parâmetros de entrada

BadgeNumber	Inteiro, número do selo do ícone.

Parâmetros de saída

Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

SetLanguage

Define um idioma personalizado para a aplicação em vez do idioma padrão do sistema.

Parâmetros de entrada

Language	Texto, idioma personalizado da aplicação no formato ISO de 2 letras (por exemplo, “en”, “es”, “fr”)

SetTags

Envia tags e seus valores para o Pushwoosh.

Parâmetros de entrada

Tags	Lista de Registros de TagName e TagValue contendo todas as tags que você deseja enviar. O tipo de TagName deve ser sempre Texto, enquanto TagValue pode ser Texto, Inteiro, Booleano, Data, etc.

Parâmetros de saída

Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

Exemplo de uso

1. Atribua valores às tags. No exemplo abaixo, existem duas tags:

• Tag1 com o nome testTag e seu valor definido para a data atual.
• Tag2 com o nome testTag2 e seu valor definido como Verdadeiro.

2. Em seguida, anexe as tags a uma lista. Neste exemplo:

• ListAppend3 adiciona Tag1 à lista LocalTag.
• ListAppend4 adiciona Tag2 à lista LocalTag.

3. Após preencher a lista com as tags necessárias, use a ação de cliente SetTags para enviar esta lista para o Pushwoosh.

SetUserId

Atribui um ID de Usuário personalizado a este dispositivo.

Parâmetros de entrada

UserID	Texto, ID de Usuário personalizado.

Parâmetros de saída

Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

SetApiToken

Define o token da API de Dispositivo do Pushwoosh usado pelo SDK. Chame-o antes de RegisterDevice. O token também pode ser definido no momento da compilação com a preferência PW_API_TOKEN — consulte o guia de integração.

Parâmetros de entrada

Token	Texto, o token da API de Dispositivo do Painel de Controle do Pushwoosh (seção Acesso à API).

EnableHuaweiPushNotifications

Muda o transporte de push para o Huawei Push Kit (HMS). Chame-o antes de RegisterDevice em dispositivos Huawei. Requer a configuração da Huawei — consulte Huawei para Outsystems.

A ação não possui parâmetros de saída e não relata sucesso ou falha. Para verificar com qual transporte o dispositivo realmente se registrou, use GetDiagnostics.

SetMultiNotificationMode

Disponível desde a versão 4.7.0 do componente do Plugin Pushwoosh. Apenas para Android — faz com que cada push apareça como uma notificação separada em vez de substituir a anterior. Chame-o uma vez após a inicialização — por exemplo, no manipulador do evento OnInitializeOver, após RegisterDevice. A configuração é armazenada pelo SDK e sobrevive a reinicializações do aplicativo. O Android agrupa as notificações em uma pilha expansível — esse é o comportamento padrão do sistema. Não há implementação para iOS (o iOS nunca substitui notificações) — proteja a chamada com GetDeviceType em vez de colocá-la em um fluxo que também é executado no iOS.

GetDiagnostics

Disponível desde a versão 4.7.0 do componente do Plugin Pushwoosh. Retorna o estado da integração como uma string JSON: o Código da Aplicação efetivo e o integrado e de onde veio, a presença do token da API, HWID, token de push, estado da permissão de notificação e as versões do plugin e do SDK nativo. No Android, ele inclui adicionalmente o ID do Usuário e a lista de serviços registrados para eventos de mensagens FCM/HMS (esses dois campos não estão presentes no iOS). Anexe sua saída aos tickets de suporte em vez de coletar logs do dispositivo.

Parâmetros de saída

DiagnosticsJSON	Texto, o estado da integração como uma string JSON.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido.

Exemplo de saída (Android):

{
  "platform": "android",
  "packageName": "com.example.app",
  "appIdEffective": "XXXXX-XXXXX",
  "appIdManifest": "XXXXX-XXXXX",
  "appIdSource": "manifest",
  "apiTokenInManifest": false,
  "hwid": "d3ba13b6-…",
  "pushToken": "eAvqvOE0…",
  "userId": "d3ba13b6-…",
  "notificationsEnabled": true,
  "messagingServices": [
    { "action": "com.google.firebase.MESSAGING_EVENT", "class": "com.pushwoosh.firebase.PushFcmIntentService", "priority": 0 }
  ],
  "pluginVersion": "8.3.72-OS.1",
  "nativeSdkVersion": "6.11.1"
}

Ações de Cliente da Caixa de Entrada do Pushwoosh

O processo de trabalho com a Caixa de Entrada é o seguinte:

1. Carregue uma lista de objetos InboxMessage.
2. Use esses objetos para renderizar a visualização da caixa de entrada.
3. Execute as ações listadas abaixo ou exclua esses objetos usando as ações descritas abaixo.

code	Texto	ID único de uma notificação da caixa de entrada.
title	Texto	Título da notificação.
message	Texto	Mensagem da notificação.
imageUrl	Texto	URL de uma imagem personalizada anexada a uma notificação.
sendDate	Data Hora	Representa a hora em que uma notificação foi enviada.
type	Inteiro	Tipo de notificação. Valores possíveis: 0 - notificação regular 1 - notificação de rich media 2 - notificação de URL 3 - notificação de deep link
bannerUrl	Texto	Contém a URL de um banner do Android.
customData	Lista de Registros de Chave e Valor	Contém uma lista de parâmetros passados como dados personalizados.
isRead	Booleano	Verdadeiro se a notificação da caixa de entrada for lida.
isActionPerformed	Booleano	Verdadeiro se a ação da notificação for executada. Para notificações regulares, verdadeiro se uma notificação for lida. Para Rich Media, verdadeiro se o rich media foi apresentado. Para URL e deep links, verdadeiro se a URL/deep link foi aberto.

LoadMessages

Busca notificações da caixa de entrada do Pushwoosh.

Parâmetros de saída

InboxMessages	Lista de InboxMessage, lista de todas as mensagens da caixa de entrada.
Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

ReadMessage

Marca a mensagem da caixa de entrada como lida.

Parâmetros de entrada

MessageCode	Texto, código de um InboxMessage (recebido como um parâmetro de um InboxMessage em LoadMessages)

Parâmetros de saída

Success	Verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

PerformAction

Executa a ação para as mensagens da caixa de entrada especificadas (por exemplo, abrir URL em um navegador).

Parâmetros de entrada

MessageCode	Texto, código de um InboxMessage (recebido como um parâmetro de um InboxMessage em LoadMessages)

Parâmetros de saída

Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

DeleteMessage

Remove uma mensagem da caixa de entrada.

Parâmetros de entrada

MessageCode	Texto, código de um InboxMessage (recebido como um parâmetro de um InboxMessage em LoadMessages)

Parâmetros de saída

Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

TotalMessagesCount

Retorna o número total de mensagens da caixa de entrada.

Parâmetros de saída

MessagesCount	Inteiro, número total de mensagens da caixa de entrada.
Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

UnreadMessagesCount

Retorna o número de mensagens não lidas na caixa de entrada.

Parâmetros de saída

UnreadMessagesCount	Inteiro, número de mensagens não lidas na caixa de entrada.
Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.

MessagesWithNoActionPerformedCount

Retorna o número de mensagens da caixa de entrada sem ação executada.

Parâmetros de saída

MessagesWithNoActionPerformedCount	Inteiro, número de mensagens da caixa de entrada sem ação executada.
Success	Retorna verdadeiro se tudo ocorrer como esperado, falso se houver um erro.
Error	Um erro contendo o código de erro e a mensagem de erro com detalhes sobre qualquer erro que possa ter ocorrido. Definido apenas quando o parâmetro de saída Success for falso.