Grundlegende Integrationsanleitung für das Mendix-Modul

Diese Anleitung führt Sie durch das Hinzufügen des Pushwoosh-Moduls zu einer bestehenden nativen mobilen Mendix-App, von der Installation aus dem Marketplace bis zum Empfang einer Benachrichtigung auf einem Gerät.

Voraussetzungen

Um das Pushwoosh-Modul in Ihre App zu integrieren, benötigen Sie Folgendes:

Anforderungen

• Ein Pushwoosh-Konto.
• Ein in Ihrem Konto eingerichtetes Pushwoosh-Projekt.
• Für die iOS-Integration:
  • Eine iOS-Plattform, die für den Versand von Push-Benachrichtigungen konfiguriert ist. Wir empfehlen, die Konfiguration für die tokenbasierte Authentifizierung als einfachsten Ansatz zu verwenden.
  • Stellen Sie während der Einrichtung das Gateway auf Sandbox ein, um Pushes an einen Simulator zu senden.
• Für die Android-Integration:
  • Eine konfigurierte Android-Plattform
  • Die Datei google-services.json und der package name aus Ihrem Firebase-Projekt.
  • Ein Firebase-Projekt, das mit Ihrer Android-Anwendung verbunden ist. Folgen Sie bei Bedarf der Firebase-Einrichtungsanleitung.
• Ihr Pushwoosh Application Code und der Pushwoosh Device API Token aus dem Pushwoosh Control Panel für Ihre Anwendung.

Der Device API Token in der obigen Liste wird für dieses Modul nicht benötigt. Das Widget verwendet nur den Application Code und nichts anderes.

Sie benötigen außerdem Folgendes:

• Mendix Studio Pro 11.12.3 oder neuer. Das Modulpaket ist mit dieser Version erstellt, und Studio Pro kann kein Paket öffnen, das von einer neueren Version als es selbst erstellt wurde.
• Ein natives mobiles Navigationsprofil in Ihrer App.
• Xcode oder Android Studio, um den nativen Build zu erstellen. Die Make It Native-App kann dieses Modul nicht ausführen, da sie keinen nativen Code von Drittanbietern enthält.

1. Installieren Sie das Modul aus dem Marketplace

Klicken Sie in Studio Pro auf das Marketplace-Symbol in der oberen rechten Ecke, suchen Sie nach Pushwoosh und klicken Sie auf Herunterladen. Studio Pro fügt Ihrer App ein Modul namens Pushwoosh hinzu.

Es muss nichts weiter installiert werden. Die nativen Bibliotheken kommen während des nativen Builds von npm und sind auf die exakte Version festgelegt, mit der das Modul getestet wurde.

2. Fügen Sie das Pushwoosh-Events-Widget zu Ihrer Startseite hinzu

Das Pushwoosh-Events-Widget startet das SDK und wandelt Push-Benachrichtigungen in Nanoflow-Events um. Es rendert nichts, also platzieren Sie es einmal auf der Seite, die im nativen mobilen Navigationsprofil zuerst geladen wird.

1. Öffnen Sie die Startseite Ihres nativen mobilen Navigationsprofils.
2. Ziehen Sie das Pushwoosh-Events-Widget auf die Seite. Es befindet sich in der Pushwoosh-Kategorie der Toolbox.
3. Setzen Sie die Eigenschaft Application Code auf den Application Code Ihrer App aus dem Pushwoosh Control Panel. Er sieht aus wie XXXXX-XXXXX.

Lassen Sie Register on load aktiviert, um das Gerät zu registrieren, sobald die App geöffnet wird. Deaktivieren Sie es, wenn Sie die Berechtigung für Benachrichtigungen lieber später an einer Stelle in der App anfordern möchten, an der die Anfrage für den Benutzer sinnvoller ist. Siehe Registrieren Sie das Gerät unten.

3. Konfigurieren Sie den nativen Build

Pushwoosh ersetzt die integrierten Push-Benachrichtigungen einer Mendix-App, anstatt neben ihnen zu arbeiten. Im Native Mobile Builder stellen Sie die Fähigkeiten wie folgt ein:

• Push-Benachrichtigungen: aus.
• Firebase Android: an, damit google-services.json weiterhin erfasst wird.

Zwei für das com.google.firebase.MESSAGING_EVENT-Event registrierte Benachrichtigungsdienste überschatten sich gegenseitig, und Benachrichtigungen kommen nicht mehr an. Unter Android stammt die FCM Sender ID aus google-services.json; sie wird nicht an das Modul übergeben.

Fügen Sie unter iOS die Fähigkeit Push Notifications zum generierten Xcode-Projekt in Signing & Capabilities hinzu und laden Sie Ihren APNs-Schlüssel in das Pushwoosh Control Panel hoch, wie in der Anleitung zur Konfiguration der iOS-Plattform beschrieben.

Build auf macOS

Studio Pro für Mac hat keinen Native Mobile Builder. Konfigurieren Sie stattdessen die native Vorlage mit dem Befehlszeilentool @mendix/native-mobile-toolkit und erstellen Sie dann die generierten iOS- und Android-Projekte lokal mit Xcode und Gradle.

4. Registrieren Sie das Gerät

Ein Gerät empfängt Benachrichtigungen erst, nachdem es bei Pushwoosh registriert wurde. Es gibt zwei Möglichkeiten zur Registrierung, und Sie benötigen eine davon.

Bei Laden registrieren. Lassen Sie die Eigenschaft Register on load des Widgets aktiviert. Das Gerät registriert sich, sobald das Widget geladen wird, und unter iOS erscheint in diesem Moment die Systemberechtigungsabfrage.

Aus einem Nanoflow registrieren. Deaktivieren Sie Register on load und rufen Sie die Aktion RegisterForPushNotifications aus einem eigenen Nanoflow auf, zum Beispiel nachdem sich der Benutzer anmeldet oder einem Zustimmungsbildschirm zustimmt. Die Aktion gibt den Push-Token als String zurück.

Um die Zustellung an ein Gerät zu beenden, rufen Sie UnregisterForPushNotifications auf.

5. Behandeln Sie eine Benachrichtigung, die bei geöffneter App ankommt

Wenn eine Benachrichtigung ankommt, während die App im Vordergrund ist, schreibt das Widget die Benachrichtigung in die von Ihnen angegebenen Attribute und löst dann den Nanoflow in On push received aus.

1. Setzen Sie Message auf ein String-Attribut, das den Benachrichtigungstext empfängt.
2. Setzen Sie Payload auf ein String-Attribut, das die vollständige Payload als JSON empfängt.
3. Setzen Sie On push received auf einen Nanoflow, der darauf reagiert, zum Beispiel einen, der eine Nachricht anzeigt oder eine Liste aktualisiert.

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

6. Behandeln Sie eine geöffnete Benachrichtigung und einen Deep Link

Wenn der Benutzer auf eine Benachrichtigung tippt, löst das Widget den Nanoflow in On push opened aus, wobei dieselben Message- und Payload-Attribute gefüllt werden.

Wenn die Benachrichtigung einen Deep Link enthält, schreibt das Widget den Link auch in das in Deep link festgelegte Attribut und löst den Nanoflow in On deep link aus. Dieser Nanoflow wird zusätzlich zu On push opened ausgeführt, also verwenden Sie ihn, um den Benutzer zu der Seite zu leiten, auf die der Link verweist.

7. Identifizieren Sie den Benutzer und setzen Sie Tags

Tags sind das, was eine Broadcast-Nachricht in eine gezielte Nachricht verwandelt. Rufen Sie SetTags aus einem beliebigen Nanoflow mit einem JSON-Objekt als Parameter auf:

'{"Language":"en","Plan":"pro","Level":7}'

Anführungszeichen in Mendix-Ausdrücken

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

Rufen Sie SetUserId mit Ihrer eigenen Benutzerkennung auf, um das Gerät einer Person anstelle eines Geräts zuzuordnen. Alle unter derselben User ID registrierten Geräte können dann mit einer einzigen Nachricht erreicht werden.

8. Posten Sie Events

Events steuern getriggerte Kampagnen und In-App-Nachrichten. Rufen Sie PostEvent mit dem Event-Namen und optional einem JSON-Objekt mit Attributen auf:

'{"product":"Coffee grinder","price":129}'

Der Event-Name muss mit dem im Pushwoosh Control Panel konfigurierten Event übereinstimmen.

9. Senden Sie eine Testbenachrichtigung

Registrieren Sie das Gerät als Testgerät und senden Sie eine Nachricht von Ihrem Pushwoosh Control Panel aus. Die Schritte finden Sie unter Testen Sie Ihre Integration.

Eine Benachrichtigung, die bei geöffneter App ankommt, wird vom System als Alarm angezeigt, und der On push received-Nanoflow wird ebenfalls ausgeführt. Um den Systemalarm zu unterdrücken und die Benachrichtigung nur im Nanoflow zu behandeln, rufen Sie SetShowForegroundAlert mit false auf. Diese Aktion funktioniert nur unter iOS.

10. Überprüfen Sie die Integration, wenn nichts ankommt

Arbeiten Sie diese Punkte der Reihe nach ab, wenn das Gerät keine Benachrichtigungen empfängt:

1. Bestätigen Sie, dass die App eine benutzerdefinierte Entwickler-App oder ein echter nativer Build ist. Die Make It Native-App enthält das Modul nicht, sodass jede Pushwoosh-Aktion darin stillschweigend fehlschlägt.
2. Bestätigen Sie die Fähigkeiten des nativen Builds: Push-Benachrichtigungen aus, Firebase Android an.
3. Bestätigen Sie, dass das Gerät registriert ist. Rufen Sie GetPushToken auf und prüfen Sie, ob ein Token anstelle eines leeren Strings zurückgegeben wird.
4. Bestätigen Sie, dass die Plattform im Pushwoosh Control Panel konfiguriert ist, mit dem hochgeladenen APNs-Schlüssel für iOS und dem Firebase-Serverschlüssel für Android.

Wenn das Gerät immer noch nicht erreichbar ist, rufen Sie GetHwid auf und eröffnen Sie ein Support-Ticket mit dieser Kennung.

Nächste Schritte

• Referenz der Modulaktionen - die Widget-Eigenschaften und die JavaScript-Aktionen, mit Parametern und Rückgabewerten
• Mendix FAQ - die Fragen, die bei der ersten Integration aufkommen