urbanairship-core/com.urbanairship.actions/AddCustomEventAction

AddCustomEventAction

open class AddCustomEventAction : Action

An action that adds a custom event.

Accepted situations: all

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

EVENT_NAME: String, Required
EVENT_VALUE: number as a String or Number
TRANSACTION_ID: String
INTERACTION_ID: String
INTERACTION_TYPE: String
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: add_custom_event_action

Default Registration Predicate: Rejects SITUATION_PUSH_RECEIVED

Constructors

AddCustomEventAction

constructor()

Types

AddCustomEventActionPredicate

open class AddCustomEventActionPredicate : ActionRegistry.Predicate

Default AddCustomEventAction predicate.

Properties

DEFAULT_REGISTRY_NAME

@NonNull

val DEFAULT_REGISTRY_NAME: String = "add_custom_event_action"

Default registry name

IN_APP_CONTEXT_METADATA_KEY

val IN_APP_CONTEXT_METADATA_KEY: String = "in_app_metadata"

Inherited properties

SITUATION_AUTOMATION

val SITUATION_AUTOMATION: Int = 6

Situation where an action is triggered from Action Automation.

SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON

val SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON: Int = 5

Situation where an action is triggered from a background notification action button.

SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON

val SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON: Int = 4

Situation where an action is triggered from a foreground notification action button.

SITUATION_MANUAL_INVOCATION

val SITUATION_MANUAL_INVOCATION: Int = 0

Situation where an action is manually invoked.

SITUATION_PUSH_OPENED

val SITUATION_PUSH_OPENED: Int = 2

Situation where an action is triggered when a push is opened.

SITUATION_PUSH_RECEIVED

val SITUATION_PUSH_RECEIVED: Int = 1

Situation where an action is triggered when a push is received.

SITUATION_WEB_VIEW_INVOCATION

val SITUATION_WEB_VIEW_INVOCATION: Int = 3

Situation where an action is triggered from a web view.

Functions

acceptsArguments

open fun acceptsArguments(@NonNull arguments: ActionArguments): Boolean

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

perform

@NonNull

open fun perform(@NonNull arguments: ActionArguments): ActionResult

Performs the action.

Inherited functions

onFinish

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

Called after the action performs.

onStart

open fun onStart(@NonNull arguments: ActionArguments)

Called before an action is performed.

shouldRunOnMainThread

open fun shouldRunOnMainThread(): Boolean

Determines which thread runs the action.