Mobile : quelle est l’API Redémarrer WalkMe et comment l’utiliser ?
Aperçu général
Prise en charge à partir de la version 1.13.0, l'API Redémarrer WalkMe permet aux développeurs d'applications d'ajuster WalkMe à leurs besoins et de contrôler la synchronisation de la session et du contenu de WalkMe.
Par défaut, la synchronisation des sessions et des contenus du SDK WalkMe Mobile s'effectue comme ceci :
- Le SDK synchronise les campagnes et l'objectif fondé sur des règles à chaque démarrage de l'application (tant qu'une connexion Internet est disponible ; sinon le mode hors ligne démarre) ;
- Une nouvelle session WalkMe démarre à chaque fois que l'utilisateur final lance l'application, même si elle était déjà ouverte en arrière-plan.
Ce comportement par défaut suffira pour la plupart des applications, mais certaines applications ont besoin de plus de contrôle sur les sessions ou les synchronisations.
Par exemple :
- Les applications qui restent constamment au premier plan (telles que les applications de point de vente) devront informer activement WalkMe de ce qui constitue une nouvelle session ;
- Si des applications continuent d'exécuter leurs processus alors qu'elles sont en arrière-plan pendant des heures ou des jours, il est parfois préférable de synchroniser activement le contenu afin de garantir que les utilisateurs disposent du contenu le plus à jour (au lieu de compter sur les utilisateurs finaux pour arrêter manuellement les processus et permettre à WalkMe de synchroniser).
L'API Redémarrer WalkMe effectuera une synchronisation du contenu et une nouvelle initialisation à chaque appel, mais nous vous recommandons de l'ajouter là où c'est le plus pertinent pour l'utilisateur final, et selon le cas d'utilisation.
Voici des exemples :
- Lorsque l'application passe au premier plan ;
- Lorsqu'un utilisateur se connecte ; et
- Lorsqu'un processus définitif, tel qu'un processus de vente, est effectué.
Étapes de mise en œuvre de l'API Redémarrer WalkMe
Vous pouvez appeler l'API Redémarrer WalkMe à l'aide de l'API suivante :
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;