Request

1. Settings

1.1. Topic Name

All global variables are supported. For example,

wk/${USERNAME}/${APP_INSTANCE_ID}/request

Default:

wk/request

1.2. Quality of Service (QoS)

Quality of Service (QoS) ensures different message delivery guarantees in case of connection failures.

Default: At Most Once (0)

1.3. Retain Handling

Control whether Webview Kiosk should receive existing retained messages when subscribing.

Default: Do Not Send (2)

1.4. Retain as Published

Controls whether retained messages from the broker keep their original retained flag when delivered to the subscriber.

Default: false

2. Payload

In addition to the Shared Subscribe Payload Properties, the following properties can be provided for all requests:

2.1. Get Status

Retrieves device and app states.

Example payload:

{
  "requestType": "get_status"
}

2.2. Get Settings

Retrieves configured user settings of your choosing by providing an array of setting keys inside the payload data. This array could look like:

[
  "device.rotation",
  "appearance.theme"
]

The values for the following settings will not be returned for security reasons:

• device.custom_auth_password
• mqtt.connection.password

If no setting keys are provided, all valid settings will be returned.

2.2.1. Parse as Array

For the the following setting keys, which are stored as strings and delimited by a new line (\n):

1. web_content.website_blacklist
2. web_content.website_whitelist
3. web_content.website_bookmarks

You can optionally use the object notation below with the parseAsArray property:

[
  // Before
  "web_content.website_blacklist",

  // After
  {
    "key": "web_content.website_blacklist",
    "parseAsArray": true
  }
]

which will return them as an array of strings split by new lines.

2.2.2. Evaluate Variables

For the following setting keys:

1. mqtt.connection.client_id
2. mqtt.publish.event.topic
3. mqtt.publish.response.topic
4. mqtt.subscribe.command.topic
5. mqtt.subscribe.settings.topic
6. mqtt.will.topic
7. mqtt.will.payload

You can optionally use the object notation below with the evaluateVariables property:

[
  // Before
  "mqtt.connection.client_id",

  // After
  {
    "key": "mqtt.connection.client_id",
    "evaluateVariables": true
  }
]

which will interpolates global variables with static values such as APP_INSTANCE_ID or USERNAME.

2.2.3. Example payload

{
  "requestType": "get_settings"
}

2.3. Get System Info

Retrieves device and app system information.

Example payload:

{
  "requestType": "get_system_info"
}