urbanairship-core/com.urbanairship.analytics/CustomEvent/Builder

Builder

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

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

Constructors

Builder

constructor(@Size(min = 1, max = 255) eventName: String)

Properties

eventName

val eventName: String

inAppContext

var inAppContext: JsonValue?

interactionId

var interactionId: String?

interactionType

var interactionType: String?

properties

var properties: MutableMap<String, JsonValue>

pushSendId

var pushSendId: String?

templateType

var templateType: String?

transactionId

var transactionId: String?

value

var value: BigDecimal?

Functions

addProperty

fun addProperty(@Size(min = 1) name: String, value: JsonSerializable): CustomEvent.Builder

fun addProperty(@Size(min = 1) name: String, value: Boolean): CustomEvent.Builder

fun addProperty(@Size(min = 1) name: String, value: Double): CustomEvent.Builder

fun addProperty(@Size(min = 1) name: String, value: Int): CustomEvent.Builder

fun addProperty(@Size(min = 1) name: String, value: Long): CustomEvent.Builder

fun addProperty(@Size(min = 1) name: String, @Size(min = 1) value: String): CustomEvent.Builder

Adds a custom property to the event.

build

fun build(): CustomEvent

Builds the custom event.

setEventValue

fun setEventValue(value: BigDecimal?): CustomEvent.Builder

fun setEventValue(value: Double): CustomEvent.Builder

fun setEventValue(value: Int): CustomEvent.Builder

Sets the event value.

fun setEventValue(value: String?): CustomEvent.Builder

Sets the event value from a String.

setInteraction

fun setInteraction(@Size(min = 1, max = 255) interactionType: String?, @Size(min = 1, max = 255) interactionId: String?): CustomEvent.Builder

Sets the interaction type and ID for the event.

setMessageCenterInteraction

fun setMessageCenterInteraction(richPushMessageId: String): CustomEvent.Builder

Sets the interaction type and ID from a Message Center message.

setProperties

fun setProperties(properties: JsonMap?): CustomEvent.Builder

Sets a JsonMap representing the event properties.

setTransactionId

fun setTransactionId(@Size(min = 1, max = 255) transactionId: String?): CustomEvent.Builder

Sets the transaction ID.