urbanairship-core/com.urbanairship.actions/AddCustomEventAction

AddCustomEventAction

class AddCustomEventAction(eventRecord: (CustomEvent) -> Unit = { Airship.analytics.recordCustomEvent(it) }) : Action(source)

An action that adds a custom event.

Accepted situations: all

Accepted argument value - A map of fields for the custom event:

com.urbanairship.analytics.CustomEvent.EVENT_NAME: String, Required
com.urbanairship.analytics.CustomEvent.EVENT_VALUE: number as a String or Number
com.urbanairship.analytics.CustomEvent.PROPERTIES: JsonMap of Strings, Booleans, Numbers, or arrays of Strings

When a custom event action is triggered from a Message Center Rich Push Message, the interaction type and ID will automatically be filled for the message if they are left blank.

Result value: null

Default Registration Name: DEFAULT_NAMES

Default Registration Predicate: Rejects Action.Situation.PUSH_RECEIVED

Constructors

AddCustomEventAction

constructor(eventRecord: (CustomEvent) -> Unit = { Airship.analytics.recordCustomEvent(it) })

Types

AddCustomEventActionPredicate

class AddCustomEventActionPredicate : ActionPredicate

Default AddCustomEventAction predicate.

Companion

object Companion

Functions

acceptsArguments

open override fun acceptsArguments(arguments: ActionArguments): Boolean

Called before an action is performed to determine if the the action can accept the arguments.

perform

open override fun perform(arguments: ActionArguments): ActionResult

Performs the action.

Inherited functions

onFinish

open fun onFinish(arguments: ActionArguments, result: ActionResult)

Called after the action performs.

onStart

open fun onStart(arguments: ActionArguments)

Called before an action is performed.

run

fun run(arguments: ActionArguments): ActionResult

Performs the action, with pre/post execution calls, if it accepts the provided arguments.

shouldRunOnMainThread

open fun shouldRunOnMainThread(): Boolean

Determines which thread runs the action.