urbanairship-core/com.urbanairship.analytics/CustomEvent

CustomEvent

class CustomEvent : Event, JsonSerializable(source)

A class that represents a custom event for the application.

Types

Builder

class Builder(@Size(min = 1, max = 255) val eventName: String)

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

Companion

object Companion

Properties

eventName

val eventName: String

Event name.

eventValue

val eventValue: BigDecimal?

The event value.

interactionId

val interactionId: String?

The interaction ID.

interactionType

val interactionType: String?

The interaction type.

properties

val properties: JsonMap

The event properties.

transactionId

val transactionId: String?

The transaction ID.

type

open override val type: EventType

Inherited properties

eventId

val eventId: String

Returns the UUID associated with the event.

priority

open val priority: Event.Priority

time

val time: String

Returns the timestamp associated with the event.

Functions

isValid

open override fun isValid(): Boolean

Validates the Event.

toJsonValue

open override fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.

track

fun track(): CustomEvent

Adds the event to Analytics.