urbanairship-core/com.urbanairship.actions/ToastAction

ToastAction

class ToastAction(contextProvider: () -> Context = { Airship.application }) : Action(source)

An action that displays text in a toast.

Accepted situations: Action.Situation.PUSH_OPENED, Action.Situation.WEB_VIEW_INVOCATION, Action.Situation.MANUAL_INVOCATION, Action.Situation.AUTOMATION, Action.Situation.BACKGROUND_NOTIFICATION_ACTION_BUTTON, and Action.Situation.FOREGROUND_NOTIFICATION_ACTION_BUTTON.

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

LENGTH_KEY: int either Toast.LENGTH_LONG or Toast.LENGTH_SHORT, Optional
TEXT_KEY: String, Required

Result value: The arguments value.

Default Registration Names: DEFAULT_NAMES

Constructors

constructor(contextProvider: () -> Context = { Airship.application })

Types

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.

open override fun perform(arguments: ActionArguments): ActionResult

Performs the action.

shouldRunOnMainThread

open override fun shouldRunOnMainThread(): Boolean

Determines which thread runs the action.

Inherited functions

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

Called after the action performs.

open fun onStart(arguments: ActionArguments)

Called before an action is performed.

performSuspending

open suspend fun performSuspending(arguments: ActionArguments): ActionResult

Performs the action, suspending until it completes.

fun run(arguments: ActionArguments): ActionResult

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

suspend fun runSuspending(arguments: ActionArguments): ActionResult

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