Interactivity

IN_01: Enable/Disable Mouse Input

  • Version: 1.0.0
  • Interface: interactivity
  • Action: in_01

Payload Definition

Type: InteractivityState
{
  "Version": "String",
  "Value": "Boolean"
}

Example definition

Type: InteractivityState
{
  "Version": "0.0.1",
  "Value": true
}

Response Codes

CodeDescription
S00000Action was received from Front End.
S00001Action from Front End has completed.
F00000Error executing the supplied function
F00001Function is not defined
F00006Action did not execute within an allotted time
F00008Function is not found
F00011The payload supplied is invalid

IN_02: Enable/Disable Keyboard Input

  • Version: 1.0.0
  • Interface: interactivity
  • Action: in_02

Payload Definition

Type: InteractivityState
{
  "Version": "String",
  "Value": "Boolean"
}

Example definition

Type: InteractivityState
{
  "Version": "0.0.1",
  "Value": true
}

Response Codes

CodeDescription
S00000Action was received from Front End.
S00001Action from Front End has completed.
F00000Error executing the supplied function
F00001Function is not defined
F00006Action did not execute within an allotted time
F00008Function is not found
F00011The payload supplied is invalid

IN_03: Change Interactivity Mode

  • Version: 1.0.0
  • Interface: interactivity
  • Action: in_03

Payload Definition

Type: EnumPayload
{
  "Version": "String",
  "Value": "Int32"
}

Example definition

Type: EnumPayload
{
  "Version": "0.0.1",
  "Value": 1
}

Response Codes

CodeDescription
S00000Action was received from Front End.
S00001Action from Front End has completed.
F00000Error executing the supplied function
F00001Function is not defined
F00006Action did not execute within an allotted time
F00008Function is not found
F00011The payload supplied is invalid

IN_04: Change Interactive View

  • Version: 1.0.0
  • Interface: interactivity
  • Action: in_04

Payload Definition

Type: EnumPayload
{
  "Version": "String",
  "Value": "Int32"
}

Example definition

Type: EnumPayload
{
  "Version": "0.0.1",
  "Value": 1
}

Response Codes

CodeDescription
S00000Action was received from Front End.
S00001Action from Front End has completed.
F00000Error executing the supplied function
F00001Function is not defined
F00006Action did not execute within an allotted time
F00008Function is not found
F00011The payload supplied is invalid
Last Updated:
Contributors: Elliott Cooper