KeySynthesizeBlock | SiteKiosk Online API

Represents a block of key actions that can be executed

Index

Constructors

Accessors

Methods

add addScanCode addText addVirtualKey clear execute

Constructors

constructor

new KeySynthesizeBlock(_keyboard: Keyboard): KeySynthesizeBlock
Parameters
- _keyboard: Keyboard
Returns KeySynthesizeBlock

Accessors

actions

get actions(): KeySynthesizeData[]
Returns KeySynthesizeData[]
set actions(value: KeySynthesizeData[]): void
Parameters
- value: KeySynthesizeData[]
Returns void

Methods

add

add(...data: (KeySynthesizeData | KeySynthesizeData[])[]): KeySynthesizeBlock
Adds multiple key actions to the block.
Parameters
- Rest ...data: (KeySynthesizeData | KeySynthesizeData[])[]
  
  The key actions to add.
Returns KeySynthesizeBlock

addScanCode

addScanCode(scanCode: number, keyAction?: KeyAction): KeySynthesizeBlock
Adds a key action to the block.
Parameters
- scanCode: number
  
  The scan code of the key.
- Optional keyAction: KeyAction
  
  The key action to perform. Default is KeyAction.PressAndRelease.
Returns KeySynthesizeBlock

addText

addText(text: string, keyAction?: KeyAction): KeySynthesizeBlock
Emits each character of the provided text
Parameters
- text: string
- Optional keyAction: KeyAction
  
  The key action to perform. Default is KeyAction.PressAndRelease.
Returns KeySynthesizeBlock

addVirtualKey

addVirtualKey(virtualKey: number, keyAction?: KeyAction): KeySynthesizeBlock
Adds a key action to the block.
Parameters
- virtualKey: number
  
  The virtual key code of the key.
- Optional keyAction: KeyAction
  
  The key action to perform. Default is KeyAction.PressAndRelease.
Returns KeySynthesizeBlock

clear

clear(): void
Clears all stored key actions.

Returns void

execute

execute(): void
Executes the block and synthesizes all stored key actions.

Returns void

Generated using TypeDoc