urbanairship-core/com.urbanairship.analytics/CustomEvent

CustomEvent

class CustomEvent : Event, JsonSerializable

A class that represents a custom event for the application.

Types

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

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

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val eventName: String

Event name.

Link copied to clipboard
val eventValue: BigDecimal?

The event value.

Link copied to clipboard
val interactionId: String? = null

The interaction ID.

Link copied to clipboard
val interactionType: String? = null

The interaction type.

Link copied to clipboard
val properties: JsonMap

The event properties.

Link copied to clipboard
val transactionId: String? = null

The transaction ID.

Inherited properties

Link copied to clipboard
protected val timeMilliseconds: Long

Functions

Link copied to clipboard
open override fun isValid(): Boolean

Validates the Event.

Link copied to clipboard
open override fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.

Link copied to clipboard
fun track(): CustomEvent

Adds the event to Analytics.

Inherited functions

Link copied to clipboard
@Nullable
protected open fun getCarrier(): String?

Returns the current carrier.

Link copied to clipboard
@NonNull
open fun getConnectionSubType(): String

Returns the connection subtype.

Link copied to clipboard
@NonNull
open fun getConnectionType(): String

Returns the connection type.

Link copied to clipboard
@NonNull
open fun getEventId(): String

Returns the UUID associated with the event.

Link copied to clipboard
open fun getPriority(): Int

The event's send priority.

Link copied to clipboard
@NonNull
open fun getTime(): String

Returns the timestamp associated with the event.

Link copied to clipboard
protected open fun getTimezone(): Long

Returns the current time zone.

Link copied to clipboard
protected open fun isDaylightSavingsTime(): Boolean

Indicates whether it is currently daylight savings time.