Supported from SDK version 1.13.0, the Restart WalkMe API lets app developers better tailor WalkMe to their needs and control the timing of WalkMe's session and content sync.
The default WalkMe Mobile SDK behavior for sessions and content sync is as follows:
This default behavior will suffice for most apps, but there are some apps with unique use cases that need more control over sessions or syncs.
For example:
The Restart WalkMe API will perform a content sync and new session initialization whenever called, but we recommend adding it where it makes the most sense from an end-user-usage perspective, and according to the use case.
Examples include the following:
The Restart WalkMe API can be called using the following API:
/** * 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()
/** * 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;