Actions du module Mendix de Pushwoosh

Le module Pushwoosh pour Mendix expose ses fonctionnalités à deux endroits : le widget Pushwoosh events, qui démarre le SDK et transforme les notifications entrantes en événements de nanoflow, et les actions JavaScript que vous appelez depuis n’importe quel nanoflow sur le profil de navigation mobile natif. Cette page liste les deux.

Propriétés du widget d’événements Pushwoosh

Le widget n’affiche rien. Placez-le une seule fois, sur la page qui se charge en premier dans le profil de navigation mobile natif. Il initialise le SDK, enregistre éventuellement l’appareil et déclenche un nanoflow pour chaque événement de notification push.

Setup

Ces propriétés démarrent le SDK et signalent quand il est prêt.

Propriété	Ce qu’elle fait
Application Code	Le code d’application Pushwoosh de votre application, par exemple XXXXX-XXXXX. Requis.
Register on load	Enregistre l’appareil dès que le widget se charge. Sur iOS, cela affiche l’invite de permission du système, donc désactivez-la si vous préférez demander plus tard avec l’action RegisterForPushNotifications.
On initialized	Un nanoflow qui s’exécute une fois que le SDK a démarré.
On registered	Un nanoflow qui s’exécute lorsque l’appareil a un jeton push.
Push token	L’attribut de chaîne dans lequel le jeton push est écrit avant l’exécution de On registered.

Push events

Ces propriétés livrent une notification entrante dans votre modèle et déclenchent un nanoflow.

Propriété	Ce qu’elle fait
Payload	L’attribut de chaîne qui reçoit la charge utile complète de la notification au format JSON.
Message	L’attribut de chaîne qui reçoit le texte de la notification.
On push received	Un nanoflow qui s’exécute lorsqu’une notification arrive alors que l’application est au premier plan.
On push opened	Un nanoflow qui s’exécute lorsque l’utilisateur appuie sur une notification.

Deep links

Ces propriétés gèrent une notification qui contient un lien vers une page spécifique de l’application.

Propriété	Ce qu’elle fait
Deep link	L’attribut de chaîne qui reçoit l’URL du lien profond de la notification.
On deep link	Un nanoflow qui s’exécute lorsqu’une notification ouverte contient un lien. Il s’exécute en plus de On push opened.

Les attributs sont remplis avant l’exécution du nanoflow, de sorte que le nanoflow peut les lire immédiatement.

Actions de configuration

Utilisez ces actions lorsque vous démarrez le SDK vous-même au lieu d’utiliser le widget.

Initialize

Initialise le SDK Pushwoosh. Appelez-la une fois, avant toute autre action Pushwoosh, généralement depuis le nanoflow de chargement de la page d’accueil. Vous n’en avez pas besoin lorsque le widget Pushwoosh events est sur la page, car le widget initialise le SDK lui-même.

Sur Android, l’ID d’expéditeur FCM provient de google-services.json, que la compilation native récupère. Il n’est pas passé à cette action.

Paramètre	Type	Description
applicationCode	String	Le code d’application Pushwoosh, par exemple XXXXX-XXXXX. Requis.
notificationHandling	String	Optionnel. default ou manual. Laissez vide pour le comportement par défaut.

Retourne un booléen qui est vrai lorsque le SDK a démarré.

Actions d’enregistrement

Ces actions contrôlent si cet appareil reçoit des notifications et exposent les identifiants qui lui sont associés.

RegisterForPushNotifications

Enregistre l’appareil pour les notifications push et retourne le jeton push. Sur iOS, cela déclenche l’invite de permission du système, donc appelez-la à un moment du flux où la demande a du sens pour l’utilisateur.

Retourne une chaîne avec le jeton push.

UnregisterForPushNotifications

Désenregistre l’appareil. Il cesse de recevoir des notifications jusqu’à ce que RegisterForPushNotifications soit de nouveau appelé.

Retourne une chaîne avec le jeton avec lequel l’appareil a été désenregistré.

GetPushToken

Retourne le jeton push actuel, ou une chaîne vide si l’appareil n’est pas encore enregistré.

Retourne une chaîne.

GetHwid

Retourne le HWID de l’appareil, l’identifiant par lequel Pushwoosh s’adresse à lui. Utilisez-le pour cibler un seul appareil depuis le panneau de contrôle Pushwoosh ou l’API serveur.

Retourne une chaîne.

Actions d’identité utilisateur

Ces actions connectent un appareil à une personne, afin qu’un message atteigne chaque appareil que cette personne utilise.

SetUserId

Associe l’appareil à un utilisateur. Appelez-la après la connexion.

Paramètre	Type	Description
userId	String	Votre propre identifiant pour l’utilisateur. Requis.

Retourne un booléen.

GetUserId

Retourne l’ID utilisateur actuellement associé à l’appareil, ou une chaîne vide si aucun n’est défini.

Retourne une chaîne.

SetEmails

Enregistre les adresses e-mail de l’utilisateur avec Pushwoosh, afin qu’ils puissent être contactés par e-mail ainsi que par push.

Paramètre	Type	Description
emails	String	Une adresse, ou plusieurs séparées par des virgules. Requis.

Retourne un booléen.

Actions de Tag

Les Tags sont les propriétés de l’appareil à partir desquelles les segments sont construits dans le panneau de contrôle Pushwoosh.

SetTags

Définit des tags sur l’appareil.

Paramètre	Type	Description
tagsJson	String	Un objet JSON, par exemple {"Language":"en","Level":7,"Premium":true}. Requis.

Retourne un booléen.

Guillemets dans les expressions Mendix

Une chaîne dans une expression Mendix est écrite entre apostrophes, de sorte que le JSON à l’intérieur conserve ses guillemets doubles sans échappement : '{"Language":"en"}'. Écrire "" ou \" à l’intérieur de l’expression produit une chaîne que l’action ne peut pas analyser.

GetTags

Retourne les tags actuellement définis sur l’appareil, sous forme de chaîne JSON.

Retourne une chaîne.

Actions d’événement

Les événements sont ce qui déclenche les campagnes et les messages in-app.

PostEvent

Poste un événement à Pushwoosh.

Paramètre	Type	Description
eventName	String	Le nom de l’événement tel que configuré dans le panneau de contrôle. Requis.
attributesJson	String	Optionnel. Un objet JSON d’attributs d’événement.

Retourne un booléen.

L’appel SDK sous-jacent ne signale ni succès ni échec, donc l’action retourne vrai dès que l’appel a été transmis au SDK.

Actions de notification locale

Les notifications locales sont produites par l’application elle-même et ne nécessitent aucun réseau, ce qui les rend adaptées pour les rappels.

ScheduleLocalNotification

Planifie une notification locale sur l’appareil.

Paramètre	Type	Description
message	String	Le texte de la notification. Requis.
afterSeconds	Integer/Long	Le temps d’attente avant de l’afficher, en secondes. Requis, et zéro ou plus.
customDataJson	String	Optionnel. Un objet JSON renvoyé avec la notification.

Retourne un booléen dès que l’appel a été transmis au SDK. Le SDK ne signale pas si la notification a été réellement planifiée.

ClearLocalNotifications

Annule les notifications locales qui ont été planifiées mais n’ont pas encore été déclenchées.

Retourne un booléen dès que l’appel a été transmis au SDK.

ClearNotificationCenter

Supprime les notifications déjà livrées de l’application du centre de notifications.

Retourne un booléen dès que l’appel a été transmis au SDK.

Actions de confidentialité

Ces actions soutiennent un bouton de consentement dans votre application, et activent ou désactivent toute la messagerie Pushwoosh pour l’appareil.

IsCommunicationEnabled

Indique si l’appareil est actuellement autorisé à recevoir des communications de Pushwoosh. Utilisez-le pour afficher l’état d’un bouton de confidentialité.

Retourne un booléen.

SetCommunicationEnabled

Active ou désactive la communication avec Pushwoosh pour l’appareil. La désactivation arrête toute messagerie, ce qui en fait l’action à lier à un bouton “ne pas me contacter”.

Paramètre	Type	Description
enabled	Boolean	Vrai pour autoriser la messagerie, faux pour l’arrêter. Requis.

Retourne un booléen.

Actions de paramètres

Ces actions modifient le comportement du SDK pour cet appareil.

SetLanguage

Remplace la langue que Pushwoosh utilise pour localiser les messages pour l’appareil. Par défaut, la langue de l’appareil est utilisée.

Paramètre	Type	Description
language	String	Un code à deux lettres tel que en, de, nl. Requis.

Retourne un booléen dès que l’appel a été transmis au SDK.

SetReverseProxy

Achemine tout le trafic Pushwoosh via votre propre point de terminaison. Appelez-la avant Initialize, sinon les premières requêtes iront directement à Pushwoosh.

Paramètre	Type	Description
url	String	L’URL de base du proxy. Requis.
headersJson	String	Optionnel. Un objet JSON d’en-têtes HTTP supplémentaires.

Retourne un booléen dès que l’appel a été transmis au SDK.

SetShowForegroundAlert

Contrôle si une notification qui arrive alors que l’application est ouverte est affichée comme une alerte système. La valeur par défaut est activée, donc désactivez-la pour gérer vous-même les notifications au premier plan via l’événement On push received du widget.

Paramètre	Type	Description
showAlert	Boolean	Vrai pour afficher l’alerte système. Requis.

Retourne un booléen dès que l’appel a été transmis au SDK.

iOS uniquement

Le SDK Android n’expose pas ce paramètre, et appeler l’action sur Android génère une erreur. Appelez-la uniquement sur iOS.

GetShowForegroundAlert

Indique si une notification arrivant alors que l’application est ouverte sera affichée comme une alerte système. C’est activé par défaut.

Retourne un booléen.

iOS uniquement

Le SDK Android n’expose pas ce paramètre, et appeler l’action sur Android génère une erreur. Appelez-la uniquement sur iOS.

Actions d’autres canaux

Ces actions enregistrent l’utilisateur pour les canaux de messagerie que Pushwoosh prend en charge au-delà du push.

RegisterSmsNumber

Enregistre le numéro de téléphone de l’utilisateur afin que Pushwoosh puisse le contacter par SMS.

Paramètre	Type	Description
phoneNumber	String	Au format international, par exemple +33612345678. Requis.

Retourne un booléen dès que l’appel a été transmis au SDK.

RegisterWhatsappNumber

Enregistre le numéro de téléphone de l’utilisateur afin que Pushwoosh puisse le contacter via WhatsApp.

Paramètre	Type	Description
phoneNumber	String	Au format international, par exemple +33612345678. Requis.

Retourne un booléen dès que l’appel a été transmis au SDK.