core/io.karte.android.tracking

Package-level declarations

Types

data class Action<T : DTO<T>>(var shortenId: String? = null, var type: String? = null, var content: T? = null, var noAction: Boolean? = null, var reason: String? = null, var responseTimestamp: String? = null) : DTO<Action<T>>

アクション情報を保持するデータクラスです。

AppInfo

class AppInfo(context: Context, repository: Repository, config: Config) : Serializable

アプリケーション情報を保持するクラスです。

Campaign

data class Campaign(var campaignId: String? = null, var serviceActionType: String? = null) : DTO<Campaign>

キャンペーン情報を保持するデータクラスです。

CustomEventName

class CustomEventName(val value: String) : EventName

カスタムイベント名を保持するクラスです。

DTO

interface DTO<T>

Data Transfer Object from JSON

Event

open class Event

イベントを表現するクラスです。

EventName

interface EventName

各イベント名を示すインターフェースです。

MessageEvent

class MessageEvent(type: MessageEventType, val campaignId: String, val shortenId: String, values: Values? = null, libraryName: String? = null) : Event

message_xxx イベント

MessageEventName

enum MessageEventName : Enum<MessageEventName> , EventName

message_xxx イベント名を定義した列挙型です。

MessageEventType

enum MessageEventType : Enum<MessageEventType>

message_xxx イベントのタイプを定義した列挙型です。

TrackCompletion

interface TrackCompletion

設定値の取得完了をハンドルするためのInterfaceです。

Tracker

class Tracker

イベントトラッキングを行うためのクラスです。送信するイベントの種類に応じて、複数のメソッドが用意されております。

track

任意の名前のイベントを送る場合に利用します。

identify

ユーザーに関する情報（ユーザーIDや名前、メールアドレス等）を送る場合に利用します。

view

画面表示に関する情報を送る場合に利用します。通常は onCreate 等で呼び出します。なおViewイベントに関しては、イベントの送信だけではなくアプリ上で画面遷移が発生したことを認識するためのものとしても利用されます。具体的には、Viewイベントを発火させたタイミングで、既にアプリ内メッセージが表示されている場合は、自動でアプリ内メッセージを非表示にします。またネイティブアプリにおける接客表示制限オプションを有効にした場合にも、ここで設定した認識結果が利用されます。

TrackerDelegate

interface TrackerDelegate

トラッキング処理過程の一部を委譲するためのタイプ。

Trigger

data class Trigger(var eventHashes: String? = null) : DTO<Trigger>

アクションのトリガー情報を保持するデータクラスです。

Values

typealias Values = Map<String, Any>

イベントに追加できるカスタムオブジェクトの型を示すエイリアスです。

Functions

valuesOf

fun valuesOf(string: String?): Values

JSON文字列をValuesオブジェクトに変換します。