モバイル：WalkMe APIの再起動およびその使用方法について

Last Updated 11月 29, 2022

Download as PDF

概要

SDKバージョン1.13.0でサポートされている、WalkMe APIの再起動により、アプリ開発者はWalkMeを自身のニーズに合わせて調整でき、WalkMeのセッションとコンテンツの同期のタイミングを制御することができます。

セッションとコンテンツ同期に関するWalkMe Mobile SDKのデフォルトの動作は次のとおりです：

• SDKは、アプリプロセスが開始されるたびに、キャンペーンとルールに基づいたゴールコンテンツを同期します（インターネット接続がある限り可能、そうでない場合はオフラインモードが開始）。
• エンドユーザーがアプリを開始するたびに、バックグラウンドで既に開いたかどうかに関わらず、新しいWalkMeセッションが開始されます。

このデフォルトの動作は、ほとんどのアプリで十分ですが、セッションをより制御する、または、同期を必要とする固有のユースケースがあるアプリもあります。

例：

• 常に前面にあるアプリ（販売時点情報管理アプリなど）は、WalkMeに、新しいセッションとして考慮すべきことを早期に知らせる必要があります。
• バックグラウンドに数時間または数日間、プロセスを実行しているアプリケーションは、ユーザーが最新のコンテンツがあることを確認するために、コンテンツを早期に同期したいと思われる場合があります（WalkMeが同期するためにエンドユーザーが手動でプロセスを終了する代わりに）。

WalkMe APIの再起動は、呼び出されるたびに、コンテンツの同期と新しいセッションの初期化を実行しますが、エンドユーザーの使用の観点から最も便利な場所に追加することを推奨します。

実装例には以下が挙げられます。

• アプリが前面に移動した際
• ユーザーがログインした際
• 販売プロセスなどの決定的なプロセスが完了した際

WalkMe APIの再起動の実装に関する手順

WalkMe APIの再起動は、次のAPIを使用して呼び出すことができます：

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;