Version:
interface

WindowInterface

typescript
interface WindowInterface

Methods

find

find(searchInput: { by: { description: WindowElementDescription }; id: string; type: "window-element" } | Promise<{ by: { description: WindowElementDescription }; id: string; type: "window-element" }>): Promise<WindowElement>

Parameters

searchInput{ by: { description: WindowElementDescription }; id: string; type: "window-element" } | Promise<{ by: { description: WindowElementDescription }; id: string; type: "window-element" }>

Returns

Promise<WindowElement>

findAll

findAll(searchInput: { by: { description: WindowElementDescription }; id: string; type: "window-element" } | Promise<{ by: { description: WindowElementDescription }; id: string; type: "window-element" }>): Promise<WindowElement[]>

Parameters

searchInput{ by: { description: WindowElementDescription }; id: string; type: "window-element" } | Promise<{ by: { description: WindowElementDescription }; id: string; type: "window-element" }>

Returns

Promise<WindowElement[]>

focus

focus(): Promise<boolean>

Returns

Promise<boolean>

getElements

getElements(maxElements?: number): Promise<WindowElement>

Parameters

maxElements?number

Returns

Promise<WindowElement>

getRegion

getRegion(): Promise<Region>

Returns

Promise<Region>

getTitle

getTitle(): Promise<string>

Returns

Promise<string>

move

move(newOrigin: Point): Promise<boolean>

Parameters

newOriginPoint

Returns

Promise<boolean>

on

on(searchInput: { by: { description: WindowElementDescription }; id: string; type: "window-element" }, callback: WindowElementCallback): void

Parameters

searchInput{ by: { description: WindowElementDescription }; id: string; type: "window-element" }
callbackWindowElementCallback

resize

resize(newSize: Size): Promise<boolean>

Parameters

newSizeSize

Returns

Promise<boolean>

waitFor

waitFor(searchInput: { by: { description: WindowElementDescription }; id: string; type: "window-element" } | Promise<{ by: { description: WindowElementDescription }; id: string; type: "window-element" }>, timeoutMs?: number, updateInterval?: number, params?: OptionalSearchParameters<PROVIDER_DATA_TYPE>): Promise<WindowElement>

Parameters

searchInput{ by: { description: WindowElementDescription }; id: string; type: "window-element" } | Promise<{ by: { description: WindowElementDescription }; id: string; type: "window-element" }>
timeoutMs?number
updateInterval?number
params?OptionalSearchParameters<PROVIDER_DATA_TYPE>

Returns

Promise<WindowElement>

Was this page helpful?