Show Desktop Step

Displays desktop and allows participant interact with operating system or installed applications.

To complete the step, use the completion setting in Timeline step definition.

Definition

• actionType : "ShowDesktop" (required)
• minimizeAll : boolean - if set to true, all running applications are minimzed before showing the desktop to the participant. Default value is false. The UXC application window is hidden in the tray during the session recording by default, irrespective to this setting.
• showTaskbar : boolean (optional) - by default, the taskbar is hidden during the session recording. If set to true, the taskbar is shown during this step. Use this option only if need the participant to interact with taskbar during the recording.

Result

• resultType : "Successful"

Examples

Shows desktop without minimizing currently open applications. The step is completed by pressing the F10 key.

{
    "action": {
        "actionType": "ShowDesktop",
        "minimizeAll": false
    },
    "completion": {
        "hotkeys": [ "F10" ]
    }
}

Shows desktop and minimizes all open applications. This step may be completed by pressing the F10 key or when the 5 minutes timeout runs out.

{
    "action": {
        "actionType": "ShowDesktop",
        "minimizeAll": true
    },
    "completion": {
        "hotkeys": [ "F10" ],
        "timeout": "00:05:00"
    }
}