Interface WindowInterface

interface WindowInterface {
    find(searchInput): Promise<WindowElement>;
    findAll(searchInput): Promise<WindowElement[]>;
    focus(): Promise<boolean>;
    getElements(maxElements?): Promise<WindowElement>;
    getRegion(): Promise<Region>;
    getTitle(): Promise<string>;
    move(newOrigin): Promise<boolean>;
    on(searchInput, callback): void;
    resize(newSize): Promise<boolean>;
    waitFor<PROVIDER_DATA_TYPE>(searchInput, timeoutMs?, updateInterval?, params?): Promise<WindowElement>;
}

Index

Methods

find findAll focus getElements getRegion getTitle move on resize waitFor

Methods

find

find(searchInput): Promise<WindowElement>
Parameters
- searchInput: {
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  } | Promise<{
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  }>
Returns Promise<WindowElement>
- Defined in lib/types/window.interface.ts:18

findAll

findAll(searchInput): Promise<WindowElement[]>
Parameters
- searchInput: {
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  } | Promise<{
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  }>
Returns Promise<WindowElement[]>
- Defined in lib/types/window.interface.ts:22

focus

focus(): Promise<boolean>
Returns Promise<boolean>
- Defined in lib/types/window.interface.ts:14

getElements

getElements(maxElements?): Promise<WindowElement>
Parameters
- Optional maxElements: number
Returns Promise<WindowElement>
- Defined in lib/types/window.interface.ts:16

getRegion

getRegion(): Promise<Region>
Returns Promise<Region>
- Defined in lib/types/window.interface.ts:8

getTitle

getTitle(): Promise<string>
Returns Promise<string>
- Defined in lib/types/window.interface.ts:6

move

move(newOrigin): Promise<boolean>
Parameters
- newOrigin: Point
Returns Promise<boolean>
- Defined in lib/types/window.interface.ts:10

on

on(searchInput, callback): void
Parameters
- searchInput: {
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  }
  - by: {
    description: WindowElementDescription;
    }
    - description: WindowElementDescription
  - id: string
  - type: "window-element"
- callback: WindowElementCallback
Returns void
- Defined in lib/types/window.interface.ts:33

resize

resize(newSize): Promise<boolean>
Parameters
- newSize: Size
Returns Promise<boolean>
- Defined in lib/types/window.interface.ts:12

waitFor

waitFor<PROVIDER_DATA_TYPE>(searchInput, timeoutMs?, updateInterval?, params?): Promise<WindowElement>
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: {
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  } | Promise<{
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  }>
- Optional timeoutMs: number
- Optional updateInterval: number
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
Returns Promise<WindowElement>
- Defined in lib/types/window.interface.ts:26

Interface WindowInterface

Index

Methods

Methods

find

Parameters

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

Returns Promise<WindowElement>

findAll

Parameters

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

Returns Promise<WindowElement[]>

focus

Returns Promise<boolean>

getElements

Parameters

Optional maxElements: number

Returns Promise<WindowElement>

getRegion

Returns Promise<Region>

getTitle

Returns Promise<string>

move

Parameters

newOrigin: Point

Returns Promise<boolean>

on

Parameters

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

by: { description: WindowElementDescription; }

description: WindowElementDescription

id: string

type: "window-element"

callback: WindowElementCallback

Returns void

resize

Parameters

newSize: Size

Returns Promise<boolean>

waitFor

Type Parameters

PROVIDER_DATA_TYPE

Parameters

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

Optional timeoutMs: number

Optional updateInterval: number

Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

Returns Promise<WindowElement>

Settings

Member Visibility

Theme

On This Page

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

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

`Optional` maxElements: number

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

by: {
description: WindowElementDescription;
}

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

`Optional` timeoutMs: number

`Optional` updateInterval: number

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>