Aktionen des Pushwoosh-Mendix-Moduls

Das Pushwoosh-Modul für Mendix stellt seine Funktionalität an zwei Stellen zur Verfügung: dem Pushwoosh-Events-Widget, das das SDK startet und eingehende Benachrichtigungen in Nanoflow-Events umwandelt, und den JavaScript-Aktionen, die Sie von jedem Nanoflow im nativen mobilen Navigationsprofil aus aufrufen. Diese Seite listet beide auf.

Eigenschaften des Pushwoosh-Events-Widgets

Das Widget rendert nichts. Platzieren Sie es einmal auf der Seite, die im nativen mobilen Navigationsprofil zuerst geladen wird. Es initialisiert das SDK, registriert optional das Gerät und löst für jedes Push-Benachrichtigungs-Event einen Nanoflow aus.

Setup

Diese Eigenschaften starten das SDK und melden, wenn es bereit ist.

Eigenschaft	Funktion
Application Code	Der Pushwoosh Application Code Ihrer App, zum Beispiel XXXXX-XXXXX. Erforderlich.
Register on load	Registriert das Gerät, sobald das Widget geladen wird. Unter iOS wird dadurch die Systemberechtigungsaufforderung angezeigt. Deaktivieren Sie dies, wenn Sie lieber später mit der RegisterForPushNotifications-Aktion fragen möchten.
On initialized	Ein Nanoflow, der ausgeführt wird, sobald das SDK gestartet wurde.
On registered	Ein Nanoflow, der ausgeführt wird, wenn das Gerät einen Push-Token hat.
Push token	Das String-Attribut, in das der Push-Token geschrieben wird, bevor On registered ausgeführt wird.

Push-Events

Diese Eigenschaften übermitteln eine eingehende Benachrichtigung an Ihr Modell und lösen einen Nanoflow aus.

Eigenschaft	Funktion
Payload	Das String-Attribut, das die vollständige Benachrichtigungs-Payload als JSON empfängt.
Message	Das String-Attribut, das den Benachrichtigungstext empfängt.
On push received	Ein Nanoflow, der ausgeführt wird, wenn eine Benachrichtigung ankommt, während die App im Vordergrund ist.
On push opened	Ein Nanoflow, der ausgeführt wird, wenn der Benutzer auf eine Benachrichtigung tippt.

Deep-Links

Diese Eigenschaften behandeln eine Benachrichtigung, die einen Link zu einer bestimmten Seite der App enthält.

Eigenschaft	Funktion
Deep link	Das String-Attribut, das die Deep-Link-URL aus der Benachrichtigung empfängt.
On deep link	Ein Nanoflow, der ausgeführt wird, wenn eine geöffnete Benachrichtigung einen Link enthält. Er wird zusätzlich zu On push opened ausgeführt.

Die Attribute werden gefüllt, bevor der Nanoflow ausgeführt wird, sodass der Nanoflow sie sofort lesen kann.

Setup-Aktionen

Verwenden Sie diese Aktionen, wenn Sie das SDK selbst starten, anstatt das Widget zu verwenden.

Initialize

Initialisiert das Pushwoosh SDK. Rufen Sie es einmal vor jeder anderen Pushwoosh-Aktion auf, typischerweise aus dem On-Load-Nanoflow der Startseite. Sie benötigen es nicht, wenn das Pushwoosh-Events-Widget auf der Seite ist, da das Widget das SDK selbst initialisiert.

Unter Android stammt die FCM Sender ID aus google-services.json, die vom nativen Build übernommen wird. Sie wird nicht an diese Aktion übergeben.

Parameter	Typ	Beschreibung
applicationCode	String	Der Pushwoosh Application Code, zum Beispiel XXXXX-XXXXX. Erforderlich.
notificationHandling	String	Optional. default oder manual. Lassen Sie es für das Standardverhalten leer.

Gibt einen Boolean zurück, der wahr ist, wenn das SDK gestartet wurde.

Registrierungsaktionen

Diese Aktionen steuern, ob dieses Gerät Benachrichtigungen empfängt, und legen die Identifikatoren frei, die es adressieren.

RegisterForPushNotifications

Registriert das Gerät für Push-Benachrichtigungen und gibt den Push-Token zurück. Unter iOS löst dies die Systemberechtigungsaufforderung aus. Rufen Sie es also an einem Punkt im Flow auf, an dem die Frage für den Benutzer sinnvoll ist.

Gibt einen String mit dem Push-Token zurück.

UnregisterForPushNotifications

Hebt die Registrierung des Geräts auf. Es empfängt keine Benachrichtigungen mehr, bis RegisterForPushNotifications erneut aufgerufen wird.

Gibt einen String mit dem Token zurück, mit dem die Registrierung des Geräts aufgehoben wurde.

GetPushToken

Gibt den aktuellen Push-Token zurück oder einen leeren String, wenn das Gerät noch nicht registriert ist.

Gibt einen String zurück.

GetHwid

Gibt die HWID des Geräts zurück, den Identifikator, mit dem Pushwoosh es adressiert. Verwenden Sie ihn, um ein einzelnes Gerät über das Pushwoosh Control Panel oder die Server-API anzusprechen.

Gibt einen String zurück.

Aktionen zur Benutzeridentität

Diese Aktionen verbinden ein Gerät mit einer Person, sodass eine Nachricht jedes Gerät erreicht, das diese Person verwendet.

SetUserId

Verknüpft das Gerät mit einem Benutzer. Rufen Sie es nach dem Login auf.

Parameter	Typ	Beschreibung
userId	String	Ihr eigener Identifikator für den Benutzer. Erforderlich.

Gibt einen Boolean zurück.

GetUserId

Gibt die aktuell mit dem Gerät verknüpfte Benutzer-ID zurück oder einen leeren String, wenn keine festgelegt ist.

Gibt einen String zurück.

SetEmails

Registriert die E-Mail-Adressen des Benutzers bei Pushwoosh, damit sie sowohl per E-Mail als auch per Push erreicht werden können.

Parameter	Typ	Beschreibung
emails	String	Eine Adresse oder mehrere, durch Kommas getrennt. Erforderlich.

Gibt einen Boolean zurück.

Tag-Aktionen

Tags sind die Geräteeigenschaften, aus denen Segmente im Pushwoosh Control Panel erstellt werden.

SetTags

Setzt Tags auf dem Gerät.

Parameter	Typ	Beschreibung
tagsJson	String	Ein JSON-Objekt, zum Beispiel {"Language":"en","Level":7,"Premium":true}. Erforderlich.

Gibt einen Boolean zurück.

Anführungszeichen in Mendix-Ausdrücken

Ein String in einem Mendix-Ausdruck wird in einfachen Anführungszeichen geschrieben, sodass das JSON darin seine doppelten Anführungszeichen ohne Escaping beibehält: '{"Language":"en"}'. Das Schreiben von "" oder \" innerhalb des Ausdrucks erzeugt einen String, den die Aktion nicht parsen kann.

GetTags

Gibt die aktuell auf dem Gerät gesetzten Tags als JSON-String zurück.

Gibt einen String zurück.

Event-Aktionen

Events sind das, wovon getriggerte Kampagnen und In-App-Nachrichten gestartet werden.

PostEvent

Sendet ein Event an Pushwoosh.

Parameter	Typ	Beschreibung
eventName	String	Der im Control Panel konfigurierte Event-Name. Erforderlich.
attributesJson	String	Optional. Ein JSON-Objekt mit Event-Attributen.

Gibt einen Boolean zurück.

Der zugrunde liegende SDK-Aufruf meldet weder Erfolg noch Misserfolg, daher gibt die Aktion wahr zurück, sobald der Aufruf an das SDK übergeben wurde.

Aktionen für lokale Benachrichtigungen

Lokale Benachrichtigungen werden von der App selbst erzeugt und benötigen kein Netzwerk, was sie für Erinnerungen geeignet macht.

ScheduleLocalNotification

Plant eine lokale Benachrichtigung auf dem Gerät.

Parameter	Typ	Beschreibung
message	String	Der Benachrichtigungstext. Erforderlich.
afterSeconds	Integer/Long	Wie lange gewartet werden soll, bevor sie angezeigt wird, in Sekunden. Erforderlich und null oder größer.
customDataJson	String	Optional. Ein JSON-Objekt, das mit der Benachrichtigung zurückgeliefert wird.

Gibt einen Boolean zurück, sobald der Aufruf an das SDK übergeben wurde. Das SDK meldet nicht zurück, ob die Benachrichtigung tatsächlich geplant wurde.

ClearLocalNotifications

Bricht lokale Benachrichtigungen ab, die geplant, aber noch nicht ausgelöst wurden.

Gibt einen Boolean zurück, sobald der Aufruf an das SDK übergeben wurde.

ClearNotificationCenter

Entfernt die bereits zugestellten Benachrichtigungen der App aus dem Benachrichtigungszentrum.

Gibt einen Boolean zurück, sobald der Aufruf an das SDK übergeben wurde.

Datenschutzaktionen

Diese Aktionen unterstützen einen Zustimmungs-Schalter in Ihrer App und schalten die gesamte Pushwoosh-Nachrichtenübermittlung für das Gerät ein oder aus.

IsCommunicationEnabled

Gibt an, ob das Gerät derzeit berechtigt ist, Kommunikation von Pushwoosh zu empfangen. Verwenden Sie es, um den Status eines Datenschutz-Schalters darzustellen.

Gibt einen Boolean zurück.

SetCommunicationEnabled

Schaltet die Kommunikation mit Pushwoosh für das Gerät ein oder aus. Das Ausschalten stoppt die gesamte Nachrichtenübermittlung, was es zur Aktion macht, die mit einem “Kontaktieren Sie mich nicht”-Schalter verbunden wird.

Parameter	Typ	Beschreibung
enabled	Boolean	Wahr, um Nachrichten zu erlauben, falsch, um sie zu stoppen. Erforderlich.

Gibt einen Boolean zurück.

Einstellungsaktionen

Diese Aktionen ändern das Verhalten des SDK für dieses Gerät.

SetLanguage

Überschreibt die Sprache, die Pushwoosh zur Lokalisierung von Nachrichten für das Gerät verwendet. Standardmäßig wird die Gerätesprache verwendet.

Parameter	Typ	Beschreibung
language	String	Ein zweibuchstabiger Code wie en, de, nl. Erforderlich.

Gibt einen Boolean zurück, sobald der Aufruf an das SDK übergeben wurde.

SetReverseProxy

Leitet den gesamten Pushwoosh-Verkehr über Ihren eigenen Endpunkt. Rufen Sie es vor Initialize auf, da sonst die frühen Anfragen direkt an Pushwoosh gehen.

Parameter	Typ	Beschreibung
url	String	Die Basis-URL des Proxys. Erforderlich.
headersJson	String	Optional. Ein JSON-Objekt mit zusätzlichen HTTP-Headern.

Gibt einen Boolean zurück, sobald der Aufruf an das SDK übergeben wurde.

SetShowForegroundAlert

Steuert, ob eine Benachrichtigung, die ankommt, während die App geöffnet ist, als Systemwarnung angezeigt wird. Die Standardeinstellung ist eingeschaltet. Schalten Sie sie aus, um Vordergrundbenachrichtigungen selbst über das On push received-Event des Widgets zu behandeln.

Parameter	Typ	Beschreibung
showAlert	Boolean	Wahr, um die Systemwarnung anzuzeigen. Erforderlich.

Gibt einen Boolean zurück, sobald der Aufruf an das SDK übergeben wurde.

Nur iOS

Das Android SDK stellt diese Einstellung nicht zur Verfügung, und das Aufrufen der Aktion unter Android führt zu einem Fehler. Rufen Sie sie nur unter iOS auf.

GetShowForegroundAlert

Gibt an, ob eine Benachrichtigung, die ankommt, während die App geöffnet ist, als Systemwarnung angezeigt wird. Sie ist standardmäßig eingeschaltet.

Gibt einen Boolean zurück.

Nur iOS

Das Android SDK stellt diese Einstellung nicht zur Verfügung, und das Aufrufen der Aktion unter Android führt zu einem Fehler. Rufen Sie sie nur unter iOS auf.

Aktionen für andere Kanäle

Diese Aktionen registrieren den Benutzer für die Nachrichtenkanäle, die Pushwoosh über Push hinaus unterstützt.

RegisterSmsNumber

Registriert die Telefonnummer des Benutzers, damit Pushwoosh sie per SMS erreichen kann.

Parameter	Typ	Beschreibung
phoneNumber	String	Im internationalen Format, zum Beispiel +4915112345678. Erforderlich.

Gibt einen Boolean zurück, sobald der Aufruf an das SDK übergeben wurde.

RegisterWhatsappNumber

Registriert die Telefonnummer des Benutzers, damit Pushwoosh sie über WhatsApp erreichen kann.

Parameter	Typ	Beschreibung
phoneNumber	String	Im internationalen Format, zum Beispiel +4915112345678. Erforderlich.

Gibt einen Boolean zurück, sobald der Aufruf an das SDK übergeben wurde.