Settings

1. Settings

1.1. Topic Name

All global variables are supported, in addition to EVENT_TYPE. For example,

wk/${USERNAME}/${APP_INSTANCE_ID}/settings

Default:

wk/settings

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. Payloads

In addition to the Shared Subscribe Payload Properties, the following properties can be specified:

Property	Type	Description
`showToast`	boolean (optional)	Whether a toast message should be displayed. Default: `true`
`reloadActivity`	boolean (optional)	Whether the activity should be reloaded, which is necessary for some settings to take effect (e.g. `device.rotation`). Default: `true`

For a list of available setting keys, refer to ./app/src/main/res/xml/app_restrictions.xml.

Example Payloads:

{
  "data": {
    "settings": {
      "appearance.theme": "LIGHT"
    }
  }
}

If a key is specified, but its value is invalid (e.g. wrong type), the default value for the key (which may differ from the current value) will be used.

Last updated on