//inappmessaging/com.rakuten.tech.mobile.inappmessaging.runtime.data.models.appevents/CustomEvent

CustomEvent

class CustomEvent(@NonNulleventName: String) : BaseEvent

Logging custom event for client to use. Note: Please don’t use the same attribute’s name more than once because the new attribute will replace the old one.

Throws

IllegalArgumentException if eventName is an empty string or is more than 255 characters.

Constructors

CustomEvent [androidJvm]
constructor(@NonNulleventName: String)

Functions

Name Summary
addAttribute [androidJvm]
@NotNull
fun addAttribute(@NotNullkey: String, @NotNullvalue: Date): CustomEvent
This method adds custom attribute of date type.
[androidJvm]
@NotNull
fun addAttribute(@NotNullkey: String, @NotNullvalue: Boolean): CustomEvent
This method adds custom attribute of boolean type.
[androidJvm]
@NotNull
fun addAttribute(@NotNullkey: String, @NotNullvalue: Double): CustomEvent
This method adds custom attribute of double type.
[androidJvm]
@NotNull
fun addAttribute(@NotNullkey: String, @NotNullvalue: Int): CustomEvent
This method adds custom attribute of integer type.
[androidJvm]
@NotNull
fun addAttribute(@NotNullkey: String, @NotNullvalue: String): CustomEvent
This method adds custom attribute of string type.
getAttributeMap [androidJvm]
@NotNull
open override fun getAttributeMap(): Map<String, Attribute?>
This method returns an unmodifiable map which contains all custom attributes.
getEventName [androidJvm]
open override fun getEventName(): String
This method returns the event name.
getEventType [androidJvm]
@NotNull
open override fun getEventType(): Int
This method returns the event type id.
getRatEventMap [androidJvm]
@NotNull
open override fun getRatEventMap(): Map<String, Any>
This method returns an unmodifiable map which contains all event’s attributes.
getTimestamp [androidJvm]
@NotNull
open override fun getTimestamp(): Long
This method returns the timestamp.
isPersistentType [androidJvm]
@NotNull
open override fun isPersistentType(): Boolean
This method returns event is persistent type (can be used by campaigns multiple times). If persistent type, event will not be removed in LocalEventRepository when used by a campaign.