Skip to main content
Version: 4.56

log

Logs a message with the desired log level. This message can then be used for debug purposes within the debug menu of the application.

Field Configurations​

KeyTypeDescriptionDefault Value
"params" (required)Objectundefinednull

Parameters​

KeyTypeDescriptionDefault Value
"async"BooleanSpecifies whether the action should perform asynchronously.null
"logLevel" (required)StringThe log level for the message.null
"message" (required)StringThe message to log.null
"prefix"StringThe prefix for the message.null

Inherited​

From Base Action

Base Action

Field Configurations

KeyTypeDescriptionDefault Value
"dynamicParams"ObjectDynamic params to retrieve data from a specific context e.g. a userSetting.null
"leadingDelimiter"StringThe leading mustache delimiter to use.null
"params"Object,ArrayObject containing the properties of the action.null
"trailingDelimiter"StringThe trailing mustache delimiter to use.null
"type"StringType 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"