core/com.amplitude.core/Amplitude

Amplitude

open class Amplitude

Amplitude

This is the SDK instance class that contains all of the SDK functionality.

Many of the SDK functions return the SDK instance back, allowing you to chain multiple methods calls together.

Constructors

fun Amplitude(configuration: Configuration)

Public Constructor.

Functions

fun add(plugin: Plugin): Amplitude

Add a plugin.

open fun build(): Deferred<Boolean>

open fun createTimeline(): Timeline

fun flush()

fun groupIdentify(groupType: String, groupName: String, identify: Identify, options: EventOptions? = null): Amplitude

fun groupIdentify(groupType: String, groupName: String, groupProperties: Map<String, Any?>?, options: EventOptions? = null): Amplitude

Identify a group. You can modify group properties by calling this api.

fun identify(identify: Identify, options: EventOptions? = null): Amplitude

Identify lets you to send an Identify object containing user property operations to Amplitude server. You can modify user properties by calling this api.

fun identify(userProperties: Map<String, Any?>?, options: EventOptions? = null): Amplitude

Identify lets you set the user properties. You can modify user properties by calling this api.

~~fun~~ ~~logEvent~~(~~event~~: BaseEvent): Amplitude

~~fun~~ ~~logRevenue~~(~~revenue~~: Revenue): Amplitude

fun remove(plugin: Plugin): Amplitude

open fun reset(): Amplitude

Reset identity:

fun revenue(event: RevenueEvent): Amplitude

Log a Revenue Event.

fun revenue(revenue: Revenue, options: EventOptions? = null): Amplitude

Create a Revenue object to hold your revenue data and properties, and log it as a revenue event using this method.

fun setDeviceId(deviceId: String): Amplitude

Sets a custom device id. Note: only do this if you know what you are doing!

fun setGroup(groupType: String, groupName: Array<String>, options: EventOptions? = null): Amplitude

Sets the user's groups.

fun setGroup(groupType: String, groupName: String, options: EventOptions? = null): Amplitude

Set the user's group.

fun setUserId(userId: String?): Amplitude

Set the user id (can be null).

fun track(event: BaseEvent, options: EventOptions? = null, callback: EventCallBack? = null): Amplitude

Track an event.

fun track(eventType: String, eventProperties: Map<String, Any?>? = null, options: EventOptions? = null): Amplitude

Log event with the specified event type, event properties, and optional event options.

Properties

amplitudeDispatcher

val amplitudeDispatcher: CoroutineDispatcher

val amplitudeScope: CoroutineScope

val configuration: Configuration

val isBuilt: Deferred<Boolean>

val logger: Logger

networkIODispatcher

val networkIODispatcher: CoroutineDispatcher

retryDispatcher

val retryDispatcher: CoroutineDispatcher

lateinit var storage: Storage

storageIODispatcher

val storageIODispatcher: CoroutineDispatcher

val store: State

val timeline: Timeline