Outsystems

Instalando o plugin Pushwoosh

Comece instalando o plugin Pushwoosh a partir da OutSystems Forge. A maneira mais rápida de fazer isso é ir para a aba OutSystems em seu ambiente de desenvolvimento e instalá-lo a partir de lá.

Configurando o Pushwoosh

Você precisará configurar o Pushwoosh para cada uma das plataformas que você irá suportar. Uma vez que sua configuração esteja pronta, você terá um Código da Aplicação do Pushwoosh que será usado com seu plugin.

Para iOS

Aprenda como configurar o Pushwoosh para iOS.

Para Android

Aprenda como configurar o Pushwoosh para Android.

Adicionando o plugin Pushwoosh à sua aplicação

Em sua aplicação, use “Manage Dependencies…” para adicionar uma referência ao plugin Pushwoosh.

Adicione o bloco “PushwooshNotifications” a:
- O bloco “Layout” se sua aplicação não tiver login
- O bloco “LayoutBlank” se sua aplicação tiver login
Ao adicionar o bloco “PushwooshNotifications”, evite adicioná-lo dentro de placeholders, pois alguns estão disponíveis apenas em tempo de design e, em tempo de execução, o Pushwoosh não funcionará.
Defina os seguintes parâmetros no PushwooshNotifications:
- PushwooshApplicationCode: O Código Pushwoosh que você obteve após criar a aplicação no Pushwoosh.
- FCMSenderId: O número de identificação que você obteve ao configurar o Android. Você pode deixar isso em branco se sua aplicação estiver disponível apenas para iOS.
- NotificationReceivedEvent (Opcional): Um evento que é chamado quando uma notificação é recebida enquanto a aplicação está em primeiro plano.
- NotificationOpenedEvent (Opcional): Um evento que é chamado quando um usuário clica em uma notificação em seu dispositivo.

Se você está usando o plugin Pushwoosh em seu aplicativo Android, faça o seguinte:

Obtenha o google-services.json do Firebase. O nome do pacote dos serviços do Google deve corresponder ao identificador do aplicativo da aplicação OutSystems que está sendo construída.
Crie um arquivo zip contendo o google-services.json na raiz.
Faça o upload do arquivo “google-services.zip” do passo anterior para sua aplicação OutSystems e certifique-se de:
- Definir o “Nome” como “google-services.zip”
- Definir “Implantar no Diretório de Destino” como “google-services”

Definindo o Código da Aplicação em tempo de compilação (recomendado)

A partir da versão 4.7.0 do componente Pushwoosh Plugin (para atualizar: instale a versão mais recente da Forge, atualize a dependência em Manage Dependencies e gere uma nova compilação nativa), o Código da Aplicação e o token de API do Dispositivo podem ser escritos na própria compilação nativa. Adicione-os como preferências à propriedade Extensibility Configurations da sua aplicação:

{
  "preferences": {
    "global": [
      { "name": "PW_APPID", "value": "XXXXX-XXXXX" },
      { "name": "PW_API_TOKEN", "value": "your Device API token" }
    ]
  }
}

Com isso, o SDK é configurado antes que qualquer JavaScript seja executado, então os pushes entregues enquanto o aplicativo não está em execução são tratados corretamente e as estatísticas de push não são perdidas. Os nomes das preferências são sensíveis a maiúsculas e minúsculas — escreva-os exatamente como mostrado. PW_API_TOKEN é opcional; o token também pode ser definido em tempo de execução com a ação do cliente SetApiToken.

Passar o Código da Aplicação através do bloco PushwooshNotifications continua funcionando; quando ambos são definidos, o valor de tempo de execução prevalece.

Registrando o dispositivo

Para que seu dispositivo receba notificações push, você precisará registrá-lo. Se seus usuários precisarem fazer login para usar a aplicação, vá para a tela “Login” e edite a ação “Login”.

Adicione o código para registrar o dispositivo após a ação “DoLogin”. Deve se parecer com algo assim:

Se sua aplicação não tiver login, você pode adicionar este código ao evento OnInitializeOver no bloco PushwooshNotifications.

Neste manipulador de eventos, chame a ação RegisterDevice.

Se você está gerando um aplicativo móvel iOS usando um certificado de desenvolvedor, você precisará adicionar uma preferência à propriedade Extensibility Configurations do seu módulo OutSystems:

{
  "preferences": {
    "global": [
      {
        "name": "aps-environment",
        "value": "development"
      }
    ]
  }
}

Esta preferência será adicionada ao seu arquivo de entitlements (saiba mais sobre entitlements na documentação do Apple Developer).

Se você está gerando um aplicativo móvel iOS usando um certificado de produção, não precisará especificar nenhuma preferência, pois o valor padrão da preferência aps-environment no OutSystems é production.

Sua aplicação agora está pronta para receber notificações push. Configure e gere seu aplicativo móvel e instale-o em seu dispositivo. Neste ponto, você pode usar a interface do Pushwoosh para enviar notificações para seu aplicativo e garantir que tudo esteja configurado corretamente. Note que você não verá uma notificação se o aplicativo estiver em execução. Em vez disso, o evento NotificationReceivedEvent é acionado imediatamente.

Enviando notificações

Para enviar notificações, você precisa de um Token de Acesso à API do Pushwoosh. Crie um acessando o console do Pushwoosh, vá para “Acesso à API” e clique em “Gerar novo token de acesso”.

Para enviar uma notificação para todos os dispositivos, use a ação SendPushNotificationToAll.

Esta ação recebe os seguintes parâmetros:

PushwooshApplicationCode: O Código Pushwoosh que você obteve após criar a aplicação no Pushwoosh.
ApiAccessToken: O Token de Acesso à API do Pushwoosh obtido anteriormente.
Message: O texto da mensagem que você deseja enviar.
Badge: Um número que é exibido no ícone da aplicação iOS.
Deeplink: Um deep link para enviar com a notificação. Aprenda como definir deep links.
InboxDays (opcional, desde 4.7.0): Por quantos dias a mensagem é mantida na Inbox do usuário, até 30. Sem ele (e sem InboxDate) o push não é salvo na Inbox.
InboxDate (opcional, desde 4.7.0): A data até a qual a mensagem é mantida na Inbox do usuário. Uma alternativa ao InboxDays.
InboxImage (opcional, desde 4.7.0): URL de uma imagem personalizada exibida ao lado da mensagem na Inbox.

Duas ações de servidor irmãs recebem os mesmos parâmetros: SendPushNotificationToToken envia para um único dispositivo identificado por seu token de push, e SendPushNotificationToUserId envia para todos os dispositivos registrados sob um determinado ID de Usuário (definido com a ação do cliente SetUserId).

Por exemplo, se você usar esta ação para enviar a mensagem “Olá do OutSystems” para uma aplicação chamada “PushTest”, o seguinte seria mostrado no iOS:

Informações adicionais

Se seu aplicativo estiver em execução, a notificação não aparecerá no dispositivo. Em vez disso, ela é enviada para o aplicativo, e o evento NotificationReceivedEvent é acionado. Você precisará definir o que deseja que o aplicativo faça nessa situação.
As notificações push podem levar um tempo para se tornarem ativas. Se você não vir as notificações chegando, espere alguns minutos antes de solucionar outros problemas.

Compartilhe seu feedback conosco

Seu feedback nos ajuda a criar uma experiência melhor, então adoraríamos ouvir de você se tiver algum problema durante o processo de integração do SDK. Se você enfrentar alguma dificuldade, não hesite em compartilhar suas ideias conosco através deste formulário.