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

DispatchKeyEventRequest

@Serializable

data class DispatchKeyEventRequest(val type: KeyEventType, val modifiers: Int? = null, val timestamp: TimeSinceEpoch? = null, val text: String? = null, val unmodifiedText: String? = null, val keyIdentifier: String? = null, val code: String? = null, val key: String? = null, val windowsVirtualKeyCode: Int? = null, val nativeVirtualKeyCode: Int? = null, val autoRepeat: Boolean? = null, val isKeypad: Boolean? = null, val isSystemKey: Boolean? = null, val location: Int? = null, val commands: List<String>? = null)

Request object containing input parameters for the InputDomain.dispatchKeyEvent command.

Constructors

constructor(type: KeyEventType, modifiers: Int? = null, timestamp: TimeSinceEpoch? = null, text: String? = null, unmodifiedText: String? = null, keyIdentifier: String? = null, code: String? = null, key: String? = null, windowsVirtualKeyCode: Int? = null, nativeVirtualKeyCode: Int? = null, autoRepeat: Boolean? = null, isKeypad: Boolean? = null, isSystemKey: Boolean? = null, location: Int? = null, commands: List<String>? = null)

Types

Builder

class Builder(val type: KeyEventType)

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

Properties

autoRepeat

val autoRepeat: Boolean?

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

code

val code: String?

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

commands

val 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

val isKeypad: Boolean?

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

isSystemKey

val isSystemKey: Boolean?

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

key

val 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

val keyIdentifier: String?

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

location

val location: Int?

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

modifiers

val modifiers: Int?

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

nativeVirtualKeyCode

val nativeVirtualKeyCode: Int?

Native virtual key code (default: 0).

text

val 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

val timestamp: TimeSinceEpoch?

Time at which the event occurred.

type

val type: KeyEventType

Type of the key event.

unmodifiedText

val 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

val windowsVirtualKeyCode: Int?

Windows virtual key code (default: 0).