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

アプリケーション内にメッセージ（ダイアログ等）を表示したい場合は、アプリ内メッセージ機能を利用することで実現可能です。

アクションは、SDKから送信したイベントをトリガーに配信され、その後SDKにより自動的にアプリケーション上に表示されます。

動作確認

イベントを送信処理を実装
接客サービスの配信トリガーとして機能するイベントを実装します。
イベントの送信については、イベントを送信するをご覧ください。
接客サービスを作成
管理画面上で接客サービスを作成します。
接客サービスの作成方法については、接客サービス作成の流れをご覧ください。
アプリケーションで確認
アプリケーションを起動し、1. で実装したイベントの送信が行われる操作を行い、2. で設定した接客サービスが配信・表示されることを確認します。

アクションの表示には WebView を利用しています。
このため管理画面上で、HTML / CSS / JavaScript をカスタマイズすることでアプリケーションのコードを変更することなく、アクションの見た目を変更することが可能となっています。

ユーザーがアクション内のリンク（aタグ）をクリックすると、SDKはリンクに指定されているURLを自動的に開きます。

リンククリック時のハンドリングをアプリケーション側で行いたい場合は、こちらをご覧ください。

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

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

KarteInAppMessaging.isPresenting().then(function(isPresenting) {
  if (isPresenting) {
    KarteInAppMessaging.dismiss();
  }
});

特定画面群では接客を表示したくないの場合、プログラムからアクションの表示を抑制することが可能です。

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

KarteInAppMessaging.suppress()

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

KarteInAppMessaging.unsuppress()

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

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

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

InAppMessagingDelegate プロトコルを実装することにより、アクションの表示状態の変化などを検知することが可能です。

現在のところ、以下の状態変化を検知することが可能です。

アクションの状態変化を検知する場合は、こちらをご覧ください。

Updated 12 months ago