Version:
interface

WindowProviderInterface

A WindowActionProvider should provide access to a system's window system

typescript
interface WindowProviderInterface

Methods

focusWindow

focusWindow(windowHandle: number): Promise<boolean>

Focuses the window addressed via its window handle

Parameters

windowHandlenumber

Returns

Promise<boolean>

getActiveWindow

getActiveWindow(): Promise<number>

returns the window handle of the currently active foreground window

Returns

Promise<number>

getWindowRegion

getWindowRegion(windowHandle: number): Promise<Region>

returns a object representing the size and position of the window addressed via its window handle

Parameters

windowHandlenumber

Returns

Promise<Region>

getWindows

getWindows(): Promise<number[]>

returns a list of window handles for further processing.
These window handles may serve as input to e.g.

Returns

Promise<number[]>

getWindowTitle

getWindowTitle(windowHandle: number): Promise<string>

returns the title of a window addressed via its window handle

Parameters

windowHandlenumber

Returns

Promise<string>

minimizeWindow

minimizeWindow(windowHandle: number): Promise<boolean>

Minimizes the window addressed via its window handle

Parameters

windowHandlenumber

Returns

Promise<boolean>

moveWindow

moveWindow(windowHandle: number, newOrigin: Point): Promise<boolean>

Moves the window addressed via its window handle to a new origin given as

Parameters

windowHandlenumber
newOriginPoint

Returns

Promise<boolean>

resizeWindow

resizeWindow(windowHandle: number, newSize: Size): Promise<boolean>

Resizes the window addressed via its window handle to a new

Parameters

windowHandlenumber
newSizeSize

Returns

Promise<boolean>

restoreWindow

restoreWindow(windowHandle: number): Promise<boolean>

Restores a window addressed via its window handle

Parameters

windowHandlenumber

Returns

Promise<boolean>

Was this page helpful?