fireEvent

Fires the specified event. CAUTION: If a query, table and template is used the template definition differs from the normal client template syntax. In this case the template is simply used to map database row names to event parameter names.

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
"eventParams"	Object	The parameters of the event to be appended.	null
"eventType" (required)	String	The name of the event to be fired.	null
"query"	String	The name of the query to be used.	null
"queryMode"	String	The query mode ("all" have to be used if the action should be performed for each result row).	null
"queryParams"	Array	The list of the query parameters to be appended.	null
"table"	String	The database table from which the data should be retrieved.	null
"template"	String	The name of the template to be applied to the database table data.	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: Fire an event

Goal: Send an event called "getData", provide database table, query, and template to it.

{
  "type": "fireEvent",
  "params": {
    "eventType": "getData",
    "table": "table",
    "query": "query",
    "template": "template"
  }
}

Result:

A fireEvent action has been created.