urbanairship-core/com.urbanairship.analytics/CustomEvent

CustomEvent

open class CustomEvent : Event, JsonSerializable

A class that represents a custom event for the application.

Types

Builder

open class Builder

Builder class for com.urbanairship.analytics.CustomEvent Objects.

Properties

CONVERSION_METADATA

@NonNull

val CONVERSION_METADATA: String = "conversion_metadata"

Hard conversion send metadata key.

CONVERSION_SEND_ID

@NonNull

val CONVERSION_SEND_ID: String = "conversion_send_id"

Hard conversion send id key.

EVENT_NAME

@NonNull

val EVENT_NAME: String = "event_name"

The event name key.

EVENT_VALUE

@NonNull

val EVENT_VALUE: String = "event_value"

The event value key.

eventName

@NonNull

@get:NonNull

val eventName: String

eventValue

@Nullable

@get:Nullable

val eventValue: BigDecimal

INTERACTION_ID

@NonNull

val INTERACTION_ID: String = "interaction_id"

The interaction ID key.

INTERACTION_TYPE

@NonNull

val INTERACTION_TYPE: String = "interaction_type"

The interaction type key.

interactionId

@Nullable

@get:Nullable

val interactionId: String

interactionType

@Nullable

@get:Nullable

val interactionType: String

LAST_RECEIVED_METADATA

@NonNull

val LAST_RECEIVED_METADATA: String = "last_received_metadata"

Last send metadata key.

MAX_CHARACTER_LENGTH

val MAX_CHARACTER_LENGTH: Int = 255

The max size for any String event value.

MAX_TOTAL_PROPERTIES_SIZE

val MAX_TOTAL_PROPERTIES_SIZE: Int = 65536

The max size of total properties in bytes.

MCRAP_TRANSACTION_TYPE

@NonNull

val MCRAP_TRANSACTION_TYPE: String = "ua_mcrap"

Rich Push Message interaction type.

PROPERTIES

@NonNull

val PROPERTIES: String = "properties"

The custom properties key.

properties

@NonNull

@get:NonNull

val properties: JsonMap

TEMPLATE_TYPE

@NonNull

val TEMPLATE_TYPE: String = "template_type"

The template type key.

TRANSACTION_ID

@NonNull

val TRANSACTION_ID: String = "transaction_id"

The event transaction id key.

transactionId

@Nullable

@get:Nullable

val transactionId: String

Inherited properties

eventId

@get:NonNull

val eventId: String

HIGH_PRIORITY

val HIGH_PRIORITY: Int = 2

High priority event.

LOW_PRIORITY

val LOW_PRIORITY: Int = 0

Low priority event.

NORMAL_PRIORITY

val NORMAL_PRIORITY: Int = 1

Normal priority event.

Functions

isValid

open fun isValid(): Boolean

Validates the Event.

newBuilder

@NonNull

open fun newBuilder(@NonNull name: String): CustomEvent.Builder

Creates a new CustomEvent builder.

toJsonValue

@NonNull

open fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.

track

@NonNull

open fun track(): CustomEvent

Adds the event to Analytics.

Inherited functions

getConnectionSubType

@NonNull

open fun getConnectionSubType(): String

Returns the connection subtype.

getConnectionType

@NonNull

open fun getConnectionType(): String

Returns the connection type.

getPriority

open fun getPriority(): Int

The event's send priority.

getTime

@NonNull

open fun getTime(): String

Returns the timestamp associated with the event.