urbanairship-core/com.urbanairship.analytics/AccountEventTemplate

AccountEventTemplate

open class AccountEventTemplate

A class that represents a custom account event template for the application.

Properties

ACCOUNT_EVENT_TEMPLATE

@NonNull

val ACCOUNT_EVENT_TEMPLATE: String = "account"

The account event template type.

LOGGED_IN

@NonNull

val LOGGED_IN: String = "logged_in"

The logged in event name.

LOGGED_OUT

@NonNull

val LOGGED_OUT: String = "logged_out"

The logged out event name.

REGISTERED_ACCOUNT_EVENT

@NonNull

val REGISTERED_ACCOUNT_EVENT: String = "registered_account"

The registered account event name.

Functions

createEvent

@NonNull

open fun createEvent(): CustomEvent

Creates the custom account event.

newLoggedInTemplate

@NonNull

open fun newLoggedInTemplate(): AccountEventTemplate

Creates a registered account event template with logged in as template id.

newLoggedOutTemplate

@NonNull

open fun newLoggedOutTemplate(): AccountEventTemplate

Creates a registered account event template with logged out as template id.

newRegisteredTemplate

@NonNull

open fun newRegisteredTemplate(): AccountEventTemplate

Creates a registered account event template.

setCategory

@NonNull

open fun setCategory(@Nullable category: String): AccountEventTemplate

Set the category.

setTransactionId

@NonNull

open fun setTransactionId(@Nullable transactionId: String): AccountEventTemplate

Set the transaction ID.

setType

@NonNull

open fun setType(type: String): AccountEventTemplate

Set the type.

setUserId

@NonNull

open fun setUserId(userId: String): AccountEventTemplate

Set the user id.

setValue

@NonNull

open fun setValue(value: Double): AccountEventTemplate

@NonNull

open fun setValue(value: Int): AccountEventTemplate

@NonNull

open fun setValue(@Nullable value: String): AccountEventTemplate

@NonNull

open fun setValue(@Nullable value: BigDecimal): AccountEventTemplate

Sets the event value.