Actions client du plugin Pushwoosh pour OutSystems

Le plugin fournit un ensemble d’actions client pour faciliter la gestion des notifications push. Ces actions vous permettent d’enregistrer et de désenregistrer des appareils, de définir et d’obtenir des tags, de gérer les messages de la boîte de réception, et plus encore.

Actions client du plugin Pushwoosh

CheckPushwooshPlugin

Valide si le plugin Pushwoosh est actuellement disponible.

Paramètres de sortie

IsAvailable	Renvoie `true` si le plugin est disponible, sinon `false`.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

Exemple d’utilisation

RegisterDevice

Enregistre un appareil pour les notifications push et récupère un Push Token.

Paramètres d’entrée

ApplicationCode	Texte, le code d’application Pushwoosh obtenu depuis les paramètres de votre compte.

Paramètres de sortie

RegisterToken	Token reçu de Google ou Apple pour l’appareil.
Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

UnregisterDevice

Désenregistre un appareil de la réception des notifications push.

Paramètres de sortie

Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

GetDeviceID

Récupère l’ID de l’appareil, qui doit être un identifiant unique.

Paramètres de sortie

DeviceHwid	L’identifiant unique de l’appareil.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement en cas d’erreur.

GetDeviceType

Obtient le type d’appareil (Android, iOS ou Windows).

Paramètres de sortie

DeviceTypeId	L’identifiant de ce type d’appareil.

GetTags

Récupère les données des tags depuis Pushwoosh.

Paramètres de sortie

Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.
Tags	Renvoie une `Key, Value Record List` contenant tous les tags assignés à cet appareil.

Exemple d’utilisation

Appelez l’action GetTags pour récupérer les données des tags depuis Pushwoosh.
Les tags renvoyés sont accessibles via la liste GetTags.Tags.

Utilisez l’action LogMessage pour enregistrer la clé et la valeur de chaque tag.

PostEvent

Envoie un message à Pushwoosh lorsqu’un événement particulier se produit dans votre application.

Paramètres d’entrée

EventName	Texte, nom de l’événement.
EventAttributes	`Key, Value Record List`, utilisée pour envoyer des données d’événement supplémentaires à Pushwoosh (par exemple, pour l’action « UserLogin », vous pourriez vouloir envoyer des données de connexion, telles que - {“username”:“John”})

Paramètres de sortie

Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

Exemple d’utilisation

1. Attribuer

Configurez des paires clé-valeur pour définir les données de l’événement. Par exemple, KeyValue1.AttributeName comme « test1 » et KeyValue1.Value comme « test1value ». De même, définissez KeyValue2 avec le nom d’attribut et la valeur appropriés.

Créez des listes d’attributs à associer à l’événement.

Enfin, configurez l’action PostEvent.

SetBadgeNumber

Définit le numéro de badge de l’icône de l’application.

Paramètres d’entrée

BadgeNumber	Entier, numéro de badge de l’icône.

Paramètres de sortie

Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

SetLanguage

Définit une langue d’application personnalisée au lieu de la langue système par défaut.

Paramètres d’entrée

Language	Texte, langue de l’application personnalisée au format ISO à 2 lettres (par ex., « en », « es », « fr »).

SetTags

Envoie les tags et leurs valeurs à Pushwoosh.

Paramètres d’entrée

Tags	`TagName, TagValue Record List` contenant tous les tags que vous souhaitez envoyer. Le type de `TagName` doit toujours être Texte, tandis que `TagValue` peut être Texte, Entier, Booléen, Date, etc.

Paramètres de sortie

Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

Exemple d’utilisation

Attribuez des valeurs de tag. Dans l’exemple ci-dessous, il y a deux tags :

Tag1 avec un nom testTag et sa valeur définie sur la date actuelle.
Tag2 avec un nom testTag2 et sa valeur définie sur True.

Ensuite, ajoutez les tags à une liste. Dans cet exemple :

ListAppend3 ajoute Tag1 à la liste LocalTag.
ListAppend4 ajoute Tag2 à la liste LocalTag.

Après avoir rempli la liste avec les tags nécessaires, utilisez l’action client SetTags pour envoyer cette liste à Pushwoosh.

SetUserId

Assigne un User ID personnalisé à cet appareil.

Paramètres d’entrée

UserID	Texte, User ID personnalisé.

Paramètres de sortie

Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

Actions client de la boîte de réception Pushwoosh

Le processus de travail avec la boîte de réception est le suivant :

Chargez une liste d’objets InboxMessage.
Utilisez ces objets pour afficher la vue de la boîte de réception.
Effectuez les actions listées ci-dessous, ou supprimez ces objets en utilisant les actions décrites ci-dessous.

code	Texte	ID unique d’une notification de la boîte de réception.
title	Texte	Titre de la notification.
message	Texte	Message de la notification.
imageUrl	Texte	URL d’une image personnalisée jointe à une notification.
sendDate	Date Heure	Représente l’heure à laquelle une notification a été envoyée.
type	Entier	Type de notification. Valeurs possibles : 0 - notification standard 1 - notification rich media 2 - notification URL 3 - notification lien profond
bannerUrl	Texte	Contient l’URL d’une bannière Android.
customData	Key, Value Record List	Contient une liste de paramètres passés en tant que données personnalisées.
isRead	Booléen	`True` si la notification de la boîte de réception est lue.
isActionPerformed	Booléen	`True` si l’action de la notification est effectuée. Pour les notifications standards, `true` si une notification est lue. Pour les Rich Media, `true` si le rich media a été présenté. Pour les URL et les liens profonds, `true` si l’URL/le lien profond a été ouvert.

LoadMessages

Récupère les notifications de la boîte de réception depuis Pushwoosh.

Paramètres de sortie

InboxMessages	`InboxMessage List`, liste de tous les messages de la boîte de réception.
Success	Renvoie true si tout se déroule comme prévu, false en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

ReadMessage

Marque le message de la boîte de réception comme lu.

Paramètres d’entrée

MessageCode	Texte, code d’un `InboxMessage` (reçu en tant que paramètre d’un `InboxMessage` dans `LoadMessages`).

Paramètres de sortie

Success	`True` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

PerformAction

Exécute une action pour les messages de la boîte de réception spécifiés (par ex., ouvrir une URL dans un navigateur).

Paramètres d’entrée

MessageCode	Texte, code d’un `InboxMessage` (reçu en tant que paramètre d’un `InboxMessage` dans `LoadMessages`).

Paramètres de sortie

Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

DeleteMessage

Supprime un message de la boîte de réception.

Paramètres d’entrée

MessageCode	Texte, code d’un `InboxMessage` (reçu en tant que paramètre d’un `InboxMessage` dans `LoadMessages`).

Paramètres de sortie

Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

TotalMessagesCount

Renvoie le nombre total de messages dans la boîte de réception.

Paramètres de sortie

MessagesCount	Entier, nombre total de messages dans la boîte de réception.
Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

UnreadMessagesCount

Renvoie le nombre de messages non lus dans la boîte de réception.

Paramètres de sortie

UnreadMessagesCount	Entier, nombre de messages non lus dans la boîte de réception.
Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.

MessagesWithNoActionPerformedCount

Renvoie le nombre de messages de la boîte de réception pour lesquels aucune action n’a été effectuée.

Paramètres de sortie

MessagesWithNoActionPerformedCount	Entier, nombre de messages de la boîte de réception pour lesquels aucune action n’a été effectuée.
Success	Renvoie `true` si tout se déroule comme prévu, `false` en cas d’erreur.
Error	Une erreur contenant le code et le message d’erreur avec des détails sur toute erreur qui aurait pu se produire. Défini uniquement lorsque le paramètre de sortie `Success` est `false`.