reloadDatabaseTable
Reloads the source of the database table.
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 |
"ignoreSince" | Boolean,String | Specifies whether the since parameter should be ignored on reload. | null |
"maxRetries" | Number | Amount of the maximum amount of allowed retries (If greater than 0, the maximum amount of retries of the request before the error event is triggerd). | null |
"onError" | String | Event to be fired if action failed. | null |
"onErrorType" | OnErrorType | Type of event that will be fired on error. | null |
"onSuccess" | String | Event to be fired if action performed successfully. | null |
"onSuccessType" | OnSuccessType | Type of event that will be fired on success. | null |
"retryDelay" | Number | Delay in seconds between retries. | null |
"showRetry" | Boolean,String | If this key is set to true and the loading overlay is visible the current retry is shown on the overlay. | null |
"table" (required) | String | The name of the database 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 reloadDatabaseTable action.
Goal: Reload the source of the database table "news", set the maxim amount of retries to 3 and a 5 second delay between them.
table
, maxRetries
and retryDelay
have to be assigned within the params
object of the action.
{
"type": "reloadDatabaseTable",
"params": {
"table": "news",
"maxRetries": 3,
"retryDelay": 5
}
}
Result:
A reloadDatabaseTable
action with described requirements is created.