clearVariable

Resets the value of a previously defined variable to null.

note

The variable itself will still exist without an assigned value!

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"variable" (required)	String	The name of the variable.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Clear a global variable

Goal: Create a clearVariable action clearing the variable isActive.

To achieve this the following code can be used:

{
  "type": "clearVariable",
  "params": {
    "variable": "isActive"
  }
}

The variable parameter specifies which variable is to be deleted.

Result:

A clearVariable action has been created.