inappmessaging / io.karte.android / KarteApp

KarteApp

class KarteApp : ActivityLifecycleCallback

KARTE SDKのエントリポイントであると共に、SDKの構成および依存ライブラリ等の管理を行うクラスです。

SDKを利用するには、KarteApp.setupを呼び出し初期化を行う必要があります。

初期化が行われていない状態では、イベントのトラッキングを始め、SDKの機能が利用できません。

なおアプリ内メッセージ等のサブモジュールについても同様です。

SDKの設定については、初期化時に一部変更することが可能です。 設定を変更して初期化を行う場合は、Configを指定してKarteApp.setupを呼び出してください。

Properties

appInfo

var appInfo: AppInfo?

appKey

KarteApp.setup 呼び出し時に指定したアプリケーションキーを返します。

var appKey: String

application

lateinit var application: Application

config

KarteApp.setup 呼び出し時に指定した設定情報を返します。

var config: Config

originalPvId

val originalPvId: String

pvId

val pvId: String

Functions

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

onActivityStopped

fun onActivityStopped(activity: Activity): Unit

optOutTemporarily

fun optOutTemporarily(): Unit

register

fun register(module: Module): Unit

repository

fun repository(namespace: String = ""): Repository

unregister

fun unregister(module: Module): Unit

Companion Object Properties

isOptOut

オプトアウトの設定有無を返します。

val isOptOut: Boolean

visitorId

ユーザーを識別するためのID(ビジターID)を返します。

val visitorId: String

Companion Object Functions

optIn

オプトインします。

fun optIn(): Unit

optOut

オプトアウトします。

fun optOut(): Unit

register

fun register(library: Library): Unit

renewVisitorId

ビジターIDを再生成します。

fun renewVisitorId(): Unit

setLogLevel

ログレベルを設定します。

fun setLogLevel(level: LogLevel): Unit

setup

SDKの初期化を行います。

fun setup(context: Context, appKey: String, config: Config? = null): Unit

unregister

fun unregister(library: Library): Unit