Switch to kiosk mode

The UI Client includes a functionality to enable or disable kiosk mode. This function can be triggered from the application via JavaScript.

tcuiclient.postMessage("System.kiosk",
    {
        "enable": false
    }
).then((result) => {});

Parameters:

Name

Type

Description

enable

boolean

Setting the enable bit activates kiosk mode. If the value is set to false, kiosk mode is disabled.

true

Callback

Type

Description

result

result:
Contains the value 0 if successfully executed, otherwise the error code.

resultMessage:
Contains a text list of all screenshots created when successfully executed. If an error occurs, an error message is displayed here.

Example (Dev-Tools):

1. Start the UI Client
2. Open the Developer Tools
3. Open the Beckhoff CMI
window.location.href = 'https://cmi.beckhoff-cloud.com/Application';
4. Run the code to start kiosk mode. Customize the code if necessary.
tcuiclient.postMessage("System.kiosk",
    {
        "enable": true
    }
).then((result) => {});
5. If necessary, check the result.
The kiosk mode has been successfully started.
Switch to kiosk mode 1:

Kiosk mode is available starting with version 1.11.2.