urbanairship-core/com.urbanairship.actions/ToastAction

ToastAction

open class ToastAction : Action

An action that displays text in a toast.

Accepted situations: SITUATION_PUSH_OPENED, SITUATION_WEB_VIEW_INVOCATION, SITUATION_MANUAL_INVOCATION, SITUATION_AUTOMATION, SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON, and SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON.

Accepted argument value - A string with the toast text or a map with:

Result value: The arguments value.

Default Registration Names: toast_action

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@NonNull
val DEFAULT_REGISTRY_NAME: String = "toast_action"
Default registry name
Link copied to clipboard
@NonNull
val LENGTH_KEY: String = "length"
Key to define the Toast's length when providing the action's value as a map.
Link copied to clipboard
@NonNull
val TEXT_KEY: String = "text"
Key to define the Toast's text when providing the action's value as a map.

Inherited properties

Link copied to clipboard
val SITUATION_AUTOMATION: Int = 6
Situation where an action is triggered from Action Automation.
val SITUATION_BACKGROUND_NOTIFICATION_ACTION_BUTTON: Int = 5
Situation where an action is triggered from a background notification action button.
val SITUATION_FOREGROUND_NOTIFICATION_ACTION_BUTTON: Int = 4
Situation where an action is triggered from a foreground notification action button.
Link copied to clipboard
val SITUATION_MANUAL_INVOCATION: Int = 0
Situation where an action is manually invoked.
Link copied to clipboard
val SITUATION_PUSH_OPENED: Int = 2
Situation where an action is triggered when a push is opened.
Link copied to clipboard
val SITUATION_PUSH_RECEIVED: Int = 1
Situation where an action is triggered when a push is received.
Link copied to clipboard
val SITUATION_WEB_VIEW_INVOCATION: Int = 3
Situation where an action is triggered from a web view.

Functions

Link copied to clipboard
open fun acceptsArguments(@NonNull arguments: ActionArguments): Boolean
Called before an action is performed to determine if the the action can accept the arguments.
Link copied to clipboard
@NonNull
open fun perform(@NonNull arguments: ActionArguments): ActionResult
Performs the action.
Link copied to clipboard
open fun shouldRunOnMainThread(): Boolean
Determines which thread runs the action.

Inherited functions

Link copied to clipboard
open fun onFinish(@NonNull arguments: ActionArguments, @NonNull result: ActionResult)
Called after the action performs.
Link copied to clipboard
open fun onStart(@NonNull arguments: ActionArguments)
Called before an action is performed.