Skip to main content

cancelTimeout

Terminates a previously set timeout.

Field Configurations

KeyTypeDescriptionDefault Value
"params"Objectundefinednull

Parameters

KeyTypeDescriptionDefault Value
"async"BooleanSpecifies whether the action should perform asynchronously.null
"background"Boolean,StringSpecifies whether this is a background timeout.false
"name"StringThe name of the timeout.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: Cancel a timeout

Goal: Create a cancelTimeout action terminating a previously set timeout.

To achieve this the following code can be used:

{
"type": "cancelTimeout",
"params": {
"name": "laterMessage",
"background": true
}
}

The name parameter specifies which timeout is to be canceled.

Result:

A cancelTimeout action has been created.