closeWebSocket

Closes a previously opened WebSocket connection with the specified name.

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
"name" (required)	String	The name of the WebSocket to be closed.	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: Close a websocket

Goal: Create a closeWebsocket action closing the websocket testsocket.

To achieve this the following code can be used:

{
  "type": "closeWebSocket",
  "params": {
    "name": "testsocket"
  }
}

The name parameter specifies the websocket that is to be closed.

Result:

A closeWebsocket action has been created.