Skip to content

SetState

The properties defined in Action are also applicable to this action.

SetState Properties

Property Type Required
LogFileName string Optional
LoggerState enum Required
MaxFileSize integer Optional
_Type const Required

LogFileName

Name of the log file. If it's missing, default will be used (ClientLog.txt).

  • type: string

LoggerState

  • type: enum

The value of this property must be equal to one of the known values below.

LoggerState Known Values

Value Description
Off
On
Toggle

MaxFileSize

Max log file size in MB. If it's missing, by default it's 5MB. Value 0 means size is not limited.

  • type: integer

_Type

  • type: const

The value of this property must be equal to:

"Action.Type.Logger.SetState"

Action Result

This action does not have an ActionResult.


Examples

{
  "_Type": "Action.Type.Logger.SetState",
  "LogFileName": "logfile.txt",
  "MaxFileSize": "6",
  "LoggerState": "Toggle"
}