cancelRequest

Cancels a request with a name. This will only guarantee, that the result of the request will be an error. If the request gets already processed by the server, a change on the server side may still occur.

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
"name"	String	The name of the request to cancel.	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 request

Show ExampleHide Example

Cancel the request with the specified name.

{
  "type": "cancelRequest",
  "params": {
    "name": "login"
  }
}