Interface ExecuteActionConfig

Configures an action which can be executed.

Hierarchy

  • ExecuteActionConfig

Properties

changeColorFilter? changePlaybackDevice? changeVolume? displayAdministrationDialog? executeScript? exitSiteKiosk? iconFilePath? invokeScreenReaderElement? logoutSiteKiosk? logoutUser? menu? name navigate? restartMachine? restartSiteKiosk? selectScreenReaderElement? showDialog? showFileManager? showTitle? showWebPage? shutdownMachine? speakScreenReaderElement? startApplication? stopScreenReaderSpeech? synthesizeKeys? title? toggleAccessibilityMenuVisibility? toggleMagnification? toggleScreenReader? toggleScreenReaderAutoSpeech? toggleVirtualKeyboard? useSmartIcon?

Properties

Optional changeColorFilter

changeColorFilter?: ChangeColorFilterActionConfig

Changes the color filter.

Optional changePlaybackDevice

changePlaybackDevice?: ChangePlaybackDeviceActionConfig

Changes the playback device.

Optional changeVolume

changeVolume?: ChangeVolumeActionConfig

Changes the volume.

Optional displayAdministrationDialog

displayAdministrationDialog?: DisplayAdministrationDialogConfig

Displays the administration dialog.

Optional executeScript

executeScript?: ExecuteScriptActionConfig

Executes a provided java script.

Optional exitSiteKiosk

exitSiteKiosk?: ExitSiteKioskActionConfig

Exits SiteKiosk.

Optional iconFilePath

iconFilePath?: string

The optional filepath to an icon. SiteKiosk will automatically search a fitting icon when this is not defined.

Optional invokeScreenReaderElement

invokeScreenReaderElement?: InvokeScreenReaderElementActionConfig

Invokes the screen reader element.

Optional logoutSiteKiosk

logoutSiteKiosk?: LogoutSiteKioskActionConfig

Performs a SiteKiosk session logout.

Optional logoutUser

logoutUser?: LogoutUserActionConfig

Logs out the current user of this machine.

Optional menu

menu?: MenuActionConfig

Displays a menu.

name

name: string

The name of the action to perform.

Optional navigate

navigate?: NavigateActionConfig

Navigates to an URL.

Optional restartMachine

restartMachine?: RestartMachineActionConfig

Restarts the machine.

Optional restartSiteKiosk

restartSiteKiosk?: RestartSiteKioskActionConfig

Restarts SiteKiosk.

Optional selectScreenReaderElement

selectScreenReaderElement?: SelectScreenReaderElementActionConfig

Changes the screen reader element.

Optional showDialog

showDialog?: ShowDialogActionConfig

Displays the specified dialog.

Optional showFileManager

showFileManager?: ShowFileManagerActionConfig

Displays the file manager.

Optional showTitle

showTitle?: boolean

When true, the title will be displayed, when false, only the tooltip will display the title. When not set the system decides based on where this item is used.

Optional showWebPage

showWebPage?: ShowWebPageActionConfig

Displays a WebPage in a non browser window.

Optional shutdownMachine

shutdownMachine?: ShutdownMachineActionConfig

Shutdowns the machine.

Optional speakScreenReaderElement

speakScreenReaderElement?: SpeakScreenReaderElementActionConfig

Speaks the screen reader element.

Optional startApplication

startApplication?: StartApplicationActionConfig

Starts the specified application.

Optional stopScreenReaderSpeech

stopScreenReaderSpeech?: StopScreenReaderSpeechActionConfig

Stops the screen reader speech.

Optional synthesizeKeys

synthesizeKeys?: SynthesizeKeysActionConfig

Synthesizes keys.

Optional title

title?: string

The title of this element. When an empty string is provided the title will be hidden. A null or undefined value indicates that the title will be auto generated.

Optional toggleAccessibilityMenuVisibility

toggleAccessibilityMenuVisibility?: ToggleAccessibilityMenuVisibilityActionConfig

Toggles the accessibility menus visibility.

Optional toggleMagnification

toggleMagnification?: ToggleMagnificationActionConfig

Toggles the magnification state.

Optional toggleScreenReader

toggleScreenReader?: ToggleScreenReaderActionConfig

Toggles the screen reader state.

Optional toggleScreenReaderAutoSpeech

toggleScreenReaderAutoSpeech?: ToggleScreenReaderAutoSpeechActionConfig

Toggles the screen reader auto speech.

Optional toggleVirtualKeyboard

toggleVirtualKeyboard?: ToggleVirtualKeyboardActionConfig

Toggles the virtual keyboard state.

Optional useSmartIcon

useSmartIcon?: boolean

When true, the system tries to get a more fitting icon for the action, for example the fav icon for a navigate action, or the exe icon for the startApplication action.

Generated using TypeDoc