Skip to main content
Version: 4.62

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: Log a message

Show ExampleHide Example

The logLevel and message params are required.

{
"type": "log",
"params": {
"logLevel": "info",
"message": "This is a test message."
}
}

The logged message reads: "I: This is a test message."