概要

SDKバージョン1.13.0以降からサポートされるRestart WalkMe APIを使用すると、アプリ開発者はWalkMeをニーズに合わせてより適切に調整し、WalkMeのセッションとコンテンツ同期のタイミングを制御することができます。

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

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

このデフォルトの動作はほとんどのアプリにとって十分なものですが、セッションまたは同期をより詳細に制御する必要がある独自のユースケースを持つアプリもあります。

例：

• 常にフォアグラウンドにあるアプリ（POSアプリなど）の場合、何を新しいセッションとして認識するのかをWalkMeに事前に知らせておく必要があります。
• アプリがバックグラウンドにある時に、数時間または数日間にわたってプロセスが存続するアプリでは、（WalkMeの同期プロセスをエンドユーザーが手動で終了させるのを当てにするのではなく）ユーザーが最新のコンテンツを利用できるように、コンテンツを事前に同期しておきたいと考えるかもしれません。

Restart WalkMe APIは、呼び出されるたびにコンテンツ同期と新しいセッションの初期化を行います。エンドユーザーの使用状況やユースケースに応じて、最も有意義な場所に追加することをお勧めします。

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

• アプリがフォアグラウンドに移動したとき
• ユーザーがログインしたとき
• 販売プロセスなどの最終プロセスが完了したとき

Restart WalkMe APIの実装手順

Restart WalkMe APIは、以下のAPIを使用して呼び出すことができます。

Android

/**
 * WalkMeセッションを再起動し、コンテンツを同期します。
 *
 * このメソッドは、{@link #start(String, String, Application)}が呼び出された後にのみ呼び出されます。
 * 古いセッションが少なくとも1分間以上経過している場合、セッションの再起動が許可されます。
 */

public static void restart（）

iOS

/**
 * WalkMeセッションを再起動し、コンテンツを同期します。
 *
 * このメソッドは、{@link #start(String, String, Application)}が呼び出された後にのみ呼び出されます。
 * 古いセッションが少なくとも1分間以上経過している場合、セッションの再起動が許可されます。
 */
 
+ (void)restart;