log
Logs a message.
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 |
"logLevel" (required) | String | The log level for the message. | null |
"message" (required) | String | The message to log. | null |
"prefix" | String | The prefix for the message. | 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: Logs a message
Goal: Create a log
action that will add a message to the apps log.
message
, and logLevel
keys have to be assigned within the params
object of the action.
{
"type": "log",
"params": {
"message": "The message to log",
"prefix": "ThePrefix",
"logLevel": "warning"
}
}
Result:
A logged message in a form like "W: ThePrefix: The message to log"