cancelTimeout
Terminates a previously set timeout.
Field Configurations
Key | Type | Description | Default Value |
---|---|---|---|
"params" | Object | undefined | null |
Parameters
Key | Type | Description | Default Value |
---|---|---|---|
"async" | Boolean | Specifies whether the action should perform asynchronously. | null |
"background" | Boolean,String | Specifies whether this is a background timeout. | false |
"name" | String | The name of the timeout. | 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: 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.