inappmessaging / io.karte.android.inappmessaging / InAppMessaging

InAppMessaging

class InAppMessaging : Library, ActionModule, UserModule, ActivityLifecycleCallback

アプリ内メッセージの管理を行うクラスです。

Types

Config

InAppMessagingモジュールの設定を保持するクラスです。

object Config

Constructors

<init>

アプリ内メッセージの管理を行うクラスです。

InAppMessaging()

Properties

isPublic	公開モジュールであるかどうか `val isPublic: Boolean`
name	ライブラリ名 `val name: String`
version	バージョン `val version: String`

Functions

configure	ライブラリを初期化します。 `fun configure(app: KarteApp): Unit`
onActivityCreated	`fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?): Unit`
onActivityPaused	`fun onActivityPaused(activity: Activity): Unit`
onActivityResumed	`fun onActivityResumed(activity: Activity): Unit`
onActivityStarted	`fun onActivityStarted(activity: Activity): Unit`
receive	Trackサーバーのレスポンスデータをハンドルします。 `fun receive(trackResponse: TrackResponse, trackRequest: TrackRequest): Unit`
renewVisitorId	ビジターIDの再生成をハンドルします。 `fun renewVisitorId(current: String, previous: String?): Unit`
reset	各画面に対するリセット要求をハンドルします。画面遷移やdismiss等の特定画面に対して表示を停止する際に呼ばれます。 `fun reset(): Unit`
resetAll	全体に対するリセット要求をハンドルします。オプトアウト等の全体の接客表示を停止する際に呼ばれます。 `fun resetAll(): Unit`
unconfigure	ライブラリを破棄します。 `fun unconfigure(app: KarteApp): Unit`

Companion Object Properties

delegate	アプリ内メッセージで発生するイベント等を委譲するためのデリゲートインスタンスを取得・設定します。 `var delegate: InAppMessagingDelegate?`
isPresenting	アプリ内メッセージの表示有無を返します。 `val isPresenting: Boolean`

Companion Object Functions

dismiss	現在表示中の全てのアプリ内メッセージを非表示にします。 `fun dismiss(): Unit`
registerPopupWindow	アプリ内で保持しているPopupWindowを渡します。 SDKはアプリ内メッセージ表示中に、渡されたPopupWindowの状態に応じてタップの透過等を行ないます。 `fun registerPopupWindow(popupWindow: PopupWindow): Unit`
registerWindow	アプリ内で保持しているTYPE_APPLICATION_PANELタイプのWindowを渡します。 SDKはアプリ内メッセージ表示中に、渡されたWindowの状態に応じてタップの透過等を行ないます。 `fun registerWindow(window: Window): Unit`
suppress	アプリ内メッセージの表示を抑制します。 `fun suppress(): Unit`
unsuppress	アプリ内メッセージの表示抑制状態を解除します。 `fun unsuppress(): Unit`