Client-Aktionen des Pushwoosh Outsystems-Plugins

Das Plugin bietet eine Reihe von Client-Aktionen, um die Verwaltung von Push-Benachrichtigungen zu erleichtern. Mit diesen Aktionen können Sie Geräte registrieren und abmelden, Tags setzen und abrufen, Posteingangsnachrichten verwalten und vieles mehr.

Client-Aktionen des Pushwoosh-Plugins

CheckPushwooshPlugin

Überprüft, ob das Pushwoosh-Plugin derzeit verfügbar ist.

Ausgabeparameter

IsAvailable	Gibt true zurück, wenn das Plugin zur Verfügung steht, andernfalls false.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

Anwendungsbeispiel

RegisterDevice

Registriert ein Gerät für Push-Benachrichtigungen und ruft ein Push-Token ab.

Eingabeparameter

ApplicationCode	Text, der Pushwoosh-Anwendungscode, den Sie aus Ihren Kontoeinstellungen erhalten.

Ausgabeparameter

RegisterToken	Token, das von Google oder Apple für das Gerät empfangen wurde.
Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

UnregisterDevice

Meldet ein Gerät vom Empfang von Push-Benachrichtigungen ab.

Ausgabeparameter

Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

GetDeviceID

Ruft die Geräte-ID ab, die ein eindeutiger Identifikator sein sollte.

Ausgabeparameter

DeviceHwid	Der eindeutige Identifikator des Geräts.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn ein Fehler aufgetreten ist.

GetDeviceType

Ruft den Gerätetyp ab (Android, iOS oder Windows).

Ausgabeparameter

DeviceTypeId	Der Identifikator dieses Gerätetyps.

GetTags

Ruft Tag-Daten von Pushwoosh ab.

Ausgabeparameter

Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.
Tags	Gibt eine Key-Value-Record-Liste zurück, die alle diesem Gerät zugewiesenen Tags enthält.

Anwendungsbeispiel

1. Rufen Sie die GetTags-Aktion auf, um die Tag-Daten von Pushwoosh abzurufen.
2. Die zurückgegebenen Tags sind über die GetTags.Tags-Liste zugänglich.

3. Verwenden Sie die LogMessage-Aktion, um den Schlüssel und den Wert jedes Tags zu protokollieren.

PostEvent

Sendet eine Nachricht an Pushwoosh, wenn ein bestimmtes Ereignis in Ihrer Anwendung eintritt.

Eingabeparameter

EventName	Text, Name des Ereignisses
EventAttributes	Key-Value-Record-Liste, die verwendet wird, um zusätzliche Ereignisdaten an Pushwoosh zu senden (z. B. für die „UserLogin“-Aktion möchten Sie möglicherweise Anmeldedaten senden, wie z. B. {"username":"John"})

Ausgabeparameter

Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

Anwendungsbeispiel

1. Zuweisen

Richten Sie Schlüssel-Wert-Paare ein, um die Daten für das Ereignis zu definieren. Zum Beispiel KeyValue1.AttributeName als „test1“ und KeyValue1.Value als „test1value“. Definieren Sie KeyValue2 auf ähnliche Weise mit dem entsprechenden Attributnamen und Wert.

2. Erstellen Sie Listen von Attributen, die mit dem Ereignis verknüpft werden sollen.

3. Konfigurieren Sie abschließend die PostEvent-Aktion.

SetBadgeNumber

Legt die Badge-Nummer des Anwendungssymbols fest.

Eingabeparameter

BadgeNumber	Integer, Badge-Nummer des Symbols.

Ausgabeparameter

Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

SetLanguage

Legt eine benutzerdefinierte Anwendungssprache anstelle der Standardsystemsprache fest.

Eingabeparameter

Language	Text, benutzerdefinierte Anwendungssprache im 2-Buchstaben-ISO-Format (z. B. „en“, „es“, „fr“)

SetTags

Sendet Tags und ihre Werte an Pushwoosh.

Eingabeparameter

Tags	TagName, TagValue-Record-Liste, die alle Tags enthält, die Sie senden möchten. Der Typ von TagName sollte immer Text sein, während TagValue Text, Integer, Boolean, Date usw. sein kann.

Ausgabeparameter

Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

Anwendungsbeispiel

1. Weisen Sie Tag-Werte zu. Im folgenden Beispiel gibt es zwei Tags:

• Tag1 mit dem Namen testTag und seinem Wert, der auf das aktuelle Datum gesetzt ist.
• Tag2 mit dem Namen testTag2 und seinem Wert, der auf True gesetzt ist.

2. Fügen Sie dann Tags zu einer Liste hinzu. In diesem Beispiel:

• ListAppend3 fügt Tag1 zur LocalTag-Liste hinzu.
• ListAppend4 fügt Tag2 zur LocalTag-Liste hinzu.

3. Nachdem Sie die Liste mit den erforderlichen Tags gefüllt haben, verwenden Sie die SetTags-Client-Aktion, um diese Liste an Pushwoosh zu senden.

SetUserId

Weist diesem Gerät eine benutzerdefinierte User-ID zu.

Eingabeparameter

UserID	Text, benutzerdefinierte User-ID.

Ausgabeparameter

Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

Pushwoosh Inbox Client-Aktionen

Der Prozess der Arbeit mit dem Posteingang ist wie folgt:

1. Laden Sie eine Liste von InboxMessage-Objekten.
2. Verwenden Sie diese Objekte, um die Posteingangsanzeige zu rendern.
3. Führen Sie die unten aufgeführten Aktionen aus oder löschen Sie diese Objekte mit den unten beschriebenen Aktionen.

code	Text	Eindeutige ID einer Posteingangsbenachrichtigung.
title	Text	Titel der Benachrichtigung.
message	Text	Nachricht der Benachrichtigung.
imageUrl	Text	URL eines benutzerdefinierten Bildes, das an eine Benachrichtigung angehängt ist.
sendDate	Datum Uhrzeit	Stellt die Zeit dar, zu der eine Benachrichtigung gesendet wurde.
type	Integer	Typ der Benachrichtigung. Mögliche Werte: 0 - reguläre Benachrichtigung 1 - Rich-Media-Benachrichtigung 2 - URL-Benachrichtigung 3 - Deep-Link-Benachrichtigung
bannerUrl	Text	Enthält die URL eines Android-Banners.
customData	Key, Value Record List	Enthält eine Liste von Parametern, die als benutzerdefinierte Daten übergeben werden.
isRead	Boolean	True, wenn die Posteingangsbenachrichtigung gelesen wurde.
isActionPerformed	Boolean	True, wenn die Benachrichtigungsaktion ausgeführt wurde. Bei regulären Benachrichtigungen true, wenn eine Benachrichtigung gelesen wurde. Bei Rich Media true, wenn Rich Media präsentiert wurde. Bei URL und Deep Links true, wenn die URL/der Deep Link geöffnet wurde.

LoadMessages

Ruft Posteingangsbenachrichtigungen von Pushwoosh ab.

Ausgabeparameter

InboxMessages	InboxMessage-Liste, Liste aller Posteingangsnachrichten.
Success	Gibt true zurück, wenn alles wie erwartet verläuft, false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

ReadMessage

Markiert die Posteingangsnachricht als gelesen.

Eingabeparameter

MessageCode	Text, Code einer InboxMessage (als Parameter einer InboxMessage in LoadMessages erhalten)

Ausgabeparameter

Success	True, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

PerformAction

Führt eine Aktion für angegebene Posteingangsnachrichten aus (z. B. URL in einem Browser öffnen).

Eingabeparameter

MessageCode	Text, Code einer InboxMessage (als Parameter einer InboxMessage in LoadMessages erhalten)

Ausgabeparameter

Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

DeleteMessage

Entfernt eine Nachricht aus dem Posteingang.

Eingabeparameter

MessageCode	Text, Code einer InboxMessage (als Parameter einer InboxMessage in LoadMessages erhalten)

Ausgabeparameter

Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

TotalMessagesCount

Gibt die Gesamtzahl der Posteingangsnachrichten zurück.

Ausgabeparameter

MessagesCount	Integer, Gesamtzahl der Posteingangsnachrichten.
Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

UnreadMessagesCount

Gibt die Anzahl der ungelesenen Posteingangsnachrichten zurück.

Ausgabeparameter

UnreadMessagesCount	Integer, Anzahl der ungelesenen Posteingangsnachrichten.
Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.

MessagesWithNoActionPerformedCount

Gibt die Anzahl der Posteingangsnachrichten zurück, für die keine Aktion ausgeführt wurde.

Ausgabeparameter

MessagesWithNoActionPerformedCount	Integer, Anzahl der Posteingangsnachrichten, für die keine Aktion ausgeführt wurde.
Success	Gibt true zurück, wenn alles wie erwartet verläuft, andernfalls false, wenn ein Fehler auftritt.
Error	Ein Fehler, der den Fehlercode und die Fehlermeldung mit Details zu einem möglicherweise aufgetretenen Fehler enthält. Wird nur gesetzt, wenn der Ausgabeparameter Success false ist.