setTablePollingState

Changes the polling state of a table to retrieve data from the provided source.

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
"state" (required)	String	The name of the state.	null
"table" (required)	String	The name of the table.	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: Create a setTablePollingState action

Goal: Create a setTablePollingState that is applying state "active" to the database table "chatMessages".

table and state keys have to be assigned within the params object of the action.

{
  "type": "setTablePollingState",
  "params": {
    "table": "chatMessages",
    "state": "active"
  }
}

Result:

A setTablePollingState action that applies state "active" to the DB table "chatMessages" is created.