Mobil: Was ist die Neustart-WalkMe-API und wie wird sie verwendet?
Kurzübersicht
Die ab SDK-Version 1.13.0 unterstützte Neustart-WalkMe API ermöglicht es App-Entwicklern, WalkMe besser an ihre Bedürfnisse anzupassen und das Timing der WalkMe-Sitzung und der Inhaltssynchronisierung zu steuern.
Das Standardverhalten des WalkMe Mobile SDK für Sitzungen und die Synchronisierung von Inhalten ist wie folgt:
- Das SDK synchronisiert Kampagnen und regelbasierte Zielinhalte, wenn der App-Prozess gestartet wird (solange eine Internetverbindung besteht; andernfalls wird der Offline-Modus aktiviert);
- Eine neue WalkMe-Sitzung wird jedes Mal gestartet, wenn der Endbenutzer die App startet, unabhängig davon, ob sie bereits im Hintergrund geöffnet war oder nicht.
Dieses Standardverhalten reicht für die meisten Apps aus, aber es gibt einige Apps mit einzigartigen Anwendungsfällen, die mehr Kontrolle über Sitzungen oder Synchronisierungen benötigen.
Beispiel:
- Apps, die sich ständig im Vordergrund befinden (z. B. Point-of-Sale-Apps), müssen WalkMe proaktiv mitteilen, was als neue Sitzung betrachtet werden soll.
- Apps, die ihre Prozesse am Leben erhalten, während die App stunden- oder tagelang im Hintergrund läuft, möchten möglicherweise Inhalte proaktiv synchronisieren, um sicherzustellen, dass Benutzer über die aktuellsten Inhalte verfügen (anstatt sich darauf zu verlassen, dass Endbenutzer die Prozesse für WalkMe zum Synchronisieren manuell beenden).
Die Neustart-WalkMe-API führt bei jedem Aufruf eine Inhaltssynchronisierung und eine neue Sitzungsinitialisierung durch, aber wir empfehlen, sie dort hinzuzufügen, wo es aus Sicht der Endbenutzernutzung und je nach Anwendungsfall am sinnvollsten ist.
Dazu gehören die folgenden Beispiele:
- Wenn die App in den Vordergrund wechselt;
- Wenn ein Benutzer sich anmeldet; und
- Wenn ein endgültiger Prozess wie ein Verkaufsprozess abgeschlossen ist.
Schritte zum Implementieren der Neustart-WalkMe-API
Die Restart WalkMe API kann über die folgende API aufgerufen werden:
Android
/**
* Restarts WalkMe session and syncs content.
*
* This method can only be called after {@link #start(String, String, Application)} was already called.
* Restarting the session is allowed if old session is at least 1 minute old.
*/
public static void restart()
iOS
/**
* Restarts WalkMe session and syncs content.
*
* This method can only be called after {@link #start(String, String, Application)} was already called.
* Restarting the session is allowed if old session is at least 1 minute old.
*/
+ (void)restart;