chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.input/DispatchKeyEventRequest/Builder

Builder

A builder for DispatchKeyEventRequest, which allows setting the optional parameters of the InputDomain.dispatchKeyEvent command via a lambda.

Constructors

Builder

constructor(type: KeyEventType)

Properties

autoRepeat

var autoRepeat: Boolean?

Whether the event was generated from auto repeat (default: false).

code

var code: String?

Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").

commands

var commands: List<String>?

Editing commands to send with the key event (e.g., 'selectAll') (default: []). These are related to but not equal the command names used in document.execCommand and NSStandardKeyBindingResponding. See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.

isKeypad

var isKeypad: Boolean?

Whether the event was generated from the keypad (default: false).

isSystemKey

var isSystemKey: Boolean?

Whether the event was a system key event (default: false).

key

var key: String?

Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").

keyIdentifier

var keyIdentifier: String?

Unique key identifier (e.g., 'U+0041') (default: "").

location

var location: Int?

Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0).

modifiers

var modifiers: Int?

Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).

nativeVirtualKeyCode

var nativeVirtualKeyCode: Int?

Native virtual key code (default: 0).

text

var text: String?

Text as generated by processing a virtual key code with a keyboard layout. Not needed for for keyUp and rawKeyDown events (default: "")

timestamp

var timestamp: TimeSinceEpoch?

Time at which the event occurred.

type

val type: KeyEventType

Type of the key event.

unmodifiedText

var unmodifiedText: String?

Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: "").

windowsVirtualKeyCode

var windowsVirtualKeyCode: Int?

Windows virtual key code (default: 0).

Functions

build

fun build(): DispatchKeyEventRequest