— アプリ内メッセージの表示を制御する

Usage

アプリ内メッセージを非表示にする

通常アプリ内メッセージの非表示はユーザーの操作によって行われることが一般的ですが、プログラムから非表示にすることも可能です。

プログラムから非表示にする場合は、InAppMessaging クラスの dismiss() メソッドを呼び出すことで非表示にすることが可能です。
また同クラスの isPresenting プロパティを呼び出すことで、アプリ内メッセージが表示中であるか確認することが可能です。

if InAppMessaging.shared.isPresenting {
  InAppMessaging.shared.dismiss()
}
if ([[KRTInAppMessaging shared] isPresenting]) {
  [[KRTInAppMessaging shared] dismiss];
}

アプリ内メッセージの表示を抑制する

特定画面群では接客を表示したくないの場合、プログラムからアプリ内メッセージの表示を抑制することが可能です。

InAppMessaging クラスの suppress() メソッドを呼び出すことで表示抑制モードとなり、抑制が有効となります。

InAppMessaging.shared.suppress()
[[KRTInAppMessaging shared] suppress];

また同クラスの unsuppress() メソッドを呼び出すことで表示抑制モードを解除できます。

InAppMessaging.shared.unsuppress()
[[KRTInAppMessaging shared] unsuppress];

なお、表示抑制が有効な時に接客が配信され、表示が抑制された場合には _message_suppressed イベントが発生します。

アプリ内メッセージを表示する画面を限定する

特定画面のコンテキストに合わせたアプリ内メッセージを配信する場合に、ユーザーの操作などで特定画面外に遷移した後にアプリ内メッセージが表示されてしまう場合があります。
これを抑制するために、接客サービスのオプションとしてネイティブアプリにおける接客表示制御から「表示を制限する」を用意しています。

特定の画面に限定して表示したい接客サービスの場合は、このオプションをONにしてください。

本機能は、SDKが画面の境界を正しく認識できる場合にのみ機能します。
なお画面の境界を認識するパターンは、以下の通りです。

  • Viewイベントの送信
  • 画面遷移

📘

画面境界の認識について

画面境界の認識条件については、こちら をご覧ください。

アプリ内メッセージを常駐させる

通常の画面遷移またはviewイベント発生時に接客がリセットされます。トリガーとするイベントによってはイベント発生後にviewイベントが発生してしまい、接客が表示されないことがあります。それを避けるために接客サービスのオプションとして、ネイティブアプリにおける接客表示制御から「常に表示する」を用意しています。
また、画面を跨いで常駐させたい場合にも本オプションは有効です。

オプションを有効にした接客を非表示にする方法は以下の通りです。

  • InAppMessaging.shared.dismiss() または InAppMessaging.shared.suppress() を呼び出し明示的に非表示にする
  • アプリ内メッセージ側で接客を非表示にする実装をする

📘

常駐接客の表示イベントについて

常駐接客表示中は画面遷移またはviewイベント発生時に、接客表示イベント(message_open)が発生します。

Updated 4 months ago

— アプリ内メッセージの表示を制御する


Usage

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.