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.
Action Results
are available only to subsequent actions chained to an action that stores the action result via OnSuccess
or
OnFailure
actions.
- type: ActionResult
ActivityIndicatorText¶
Text that appears on the progress bar.
- type:
string
- default:
"LOADING"
OnFailure¶
Action or rule that is executed if action fails. PLT formatter is supported.
- type: ActionOrRule
- Formatter and Binding are not supported
OnFailure Example¶
"$(PLT,'/MDKDevApp/Actions/PLTActions/FailureIOS.action', '/MDKDevApp/Actions/PLTActions/FailureAndroid.action')"
OnFailureLog¶
Message is logged if action fails.
- type: OnActionLog
OnInvalid¶
Action or rule that is executed if validation fails. PLT formatter is supported.
- type: ActionOrRule
- Formatter and Binding are not supported
OnInvalid Example¶
"$(PLT,'/MDKDevApp/Actions/PLTActions/InvalidIOS.action', '/MDKDevApp/Actions/PLTActions/InvalidAndroid.action')"
OnInvalidLog¶
Message is logged if validation fails.
- type: OnActionLog
OnSuccess¶
Action or rule that is executed if action is successful. PLT formatter is supported.
- type: ActionOrRule
- Formatter and Binding are not supported
OnSuccess Example¶
"$(PLT,'/MDKDevApp/Actions/PLTActions/SuccessIOS.action', '/MDKDevApp/Actions/PLTActions/SuccessAndroid.action')"
OnSuccessLog¶
Message is logged if action is successful.
- type: OnActionLog
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: Rule
_Type¶
- type:
string