Skip to main content
Version: 4.62

if

An if expression to call different actions depending on whether the condition is met or not.

Field Configurations

KeyTypeDescriptionDefault Value
"params" (required)Objectundefinednull

Parameters

KeyTypeDescriptionDefault Value
"async"BooleanSpecifies whether the action should perform asynchronously.null
"condition" (required)ObjectThe expression to use as condition.null
"else"ArrayList of actions to execute if the condition is false.null
"then"ArrayList of actions to execute if the condition is true.null

Inherited

From Base Action

Base Action

Field Configurations

KeyTypeDescriptionDefault Value
"dynamicParams"ObjectDynamic params to retrieve data from a specific context e.g. a userSetting.null
"leadingDelimiter"StringThe leading mustache delimiter to use.null
"params"Object,ArrayObject containing the properties of the action.null
"trailingDelimiter"StringThe trailing mustache delimiter to use.null
"type"StringType name of the action.null

Examples

Example 1: Execute an if query

Show ExampleHide Example

If action that checks whether the specified named form shroedingersCat exists and displays different messages depending on the result.

{
"type": "if",
"params": {
"condition": {
"left": {
"context": "namedForm",
"field": "shroedingersCat"
},
"mode": "exists"
},
"then": [
{
"type": "showMessage",
"params": {
"text": "does exist"
}
}
],
"else": [
{
"type": "showMessage",
"params": {
"text": "does not exist"
}
}
]
}
}