interface

RdpClient

Re-exported types from the underlying RDP core native module.

typescript

interface RdpClient

Methods

captureScreen

captureScreen(): ScreenCapture | null

Returns

ScreenCapture | null

close

close(): boolean

Returns

boolean

connect

connect(params: ConnectionParams): Promise<void>

Parameters

paramsConnectionParams

Returns

Promise<void>

getClipboard

getClipboard(): Promise<string>

Returns

Promise<string>

getLastError

getLastError(): RdpError | null

Returns

RdpError | null

getMousePosition

getMousePosition(): Point

Returns

Point

getScreenSize

getScreenSize(): ScreenSize

Returns

ScreenSize

isConnected

isConnected(): boolean

Returns

boolean

keyPress

keyPress(key: Key, down: boolean, modifiers?: ModifierKey[]): boolean

Parameters

keyKey

downboolean

modifiers?ModifierKey[]

Returns

boolean

keyTap

keyTap(key: Key, modifiers?: ModifierKey[]): boolean

Parameters

keyKey

modifiers?ModifierKey[]

Returns

boolean

mouseDrag

mouseDrag(button: Button, x: number, y: number): boolean

Parameters

buttonButton

xnumber

ynumber

Returns

boolean

mouseMove

mouseMove(x: number, y: number): boolean

Parameters

xnumber

ynumber

Returns

boolean

mouseScroll

mouseScroll(dx: number, dy: number): boolean

Parameters

dxnumber

dynumber

Returns

boolean

mouseToggle

mouseToggle(button: Button, direction: ToggleDirection): boolean

Parameters

buttonButton

directionToggleDirection

Returns

boolean

setClipboard

setClipboard(text: string): Promise<void>

Parameters

textstring

Returns

Promise<void>

typeText

typeText(text: string): boolean

Parameters

textstring

Returns

boolean

Was this page helpful?