Skip to content

Action

The following describes the common metadata properties applicable to all action types.

Note: Failed actions are events that have executed, but with errors. Invalid actions do not run at all due to validation errors.

Action Properties

Property Type Required Default
ActionResult ActionResult Optional
ActivityIndicatorText string Optional "LOADING"
OnFailure ActionOrRule Optional
OnFailureLog OnActionLog Optional
OnInvalid ActionOrRule Optional
OnInvalidLog OnActionLog Optional
OnSuccess ActionOrRule Optional
OnSuccessLog OnActionLog Optional
ShowActivityIndicator boolean Optional
ValidationRule Rule Optional
_Type string Required

ActionResult

Contains a name used to look up an action result via a target path or rule. ActionResults are available only to subsequent actions chained to an action that stores the action result via OnSuccess or OnFailure actions.


ActivityIndicatorText

Text that appears on the progress bar.

  • type: string
  • default: "LOADING"

OnFailure

Action or rule that is executed if action fails


OnFailureLog

Message is logged if action fails.


OnInvalid

Action or rule that is executed if validation fails


OnInvalidLog

Message is logged if validation fails.


OnSuccess

Action or rule that is executed if action is successful


OnSuccessLog

Message is logged if action is successful.


ShowActivityIndicator

If True, a progress bar shows the status of the activity or action(s), and is automatically dismissed on completion.

  • type: boolean

ValidationRule

Rule that validates the current action


_Type

  • type: string