Batch Android SDK/com.batch.android/BatchEventAttributes

BatchEventAttributes

open class BatchEventAttributes

Object holding attributes to be associated to an event Keys should be made of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 30 characters.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@NonNull
@get:NonNull
val attributes: Map<String, EventTypedAttribute>
Link copied to clipboard
@Nullable
@get:Nullable
open val label: String
Link copied to clipboard
val LABEL_KEY: String = "$label"
Reserved key used to set a label on events in the install centric data model and activate compatibility flows
Link copied to clipboard
@Nullable
@get:Nullable
open val tags: Set<String>
Link copied to clipboard
val TAGS_KEY: String = "$tags"
Reserved key used to set tags on events in the install centric data model and activate compatibility flows

Functions

Link copied to clipboard
open fun put(@NonNull key: String, value: Boolean): BatchEventAttributes
Add a boolean attribute for the specified key
open fun put(@NonNull key: String, @NonNull value: BatchEventAttributes): BatchEventAttributes
Add an object attribute for the specified key
open fun put(@NonNull key: String, value: Double): BatchEventAttributes
Add a double attribute for the specified key
open fun put(@NonNull key: String, value: Float): BatchEventAttributes
Add a float attribute for the specified key
open fun put(@NonNull key: String, value: Int): BatchEventAttributes
Add a integer attribute for the specified key
open fun put(@NonNull key: String, @NonNull value: String): BatchEventAttributes
Add a string attribute for the specified key
open fun put(@NonNull key: String, @NonNull value: URI): BatchEventAttributes
Add an URL attribute for the specified key
open fun put(@NonNull key: String, @NonNull value: Date): BatchEventAttributes
Add a date attribute for the specified key
open fun put(@NonNull key: String, value: Long): BatchEventAttributes
Add a long attribute for the specified key
Link copied to clipboard
open fun putObjectList(@NonNull key: String, @NonNull value: List<BatchEventAttributes>): BatchEventAttributes
Add a list of object attribute for the specified key
Link copied to clipboard
open fun putStringList(@NonNull key: String, @NonNull value: List<String>): BatchEventAttributes
Add a list of string attribute for the specified key
Link copied to clipboard
open fun validateEventAttributes(): List<String>
Validate the event data.