Interface Window

The Window aptitude provides access to the the ability to identyfy window status.

Hierarchy

Window

Index

Methods

Methods

activeWindow

activeWindow(): Promise<WindowInfo>

- Defined in window/index.ts:45
Get the currently focused window and it's data.

Returns Promise<WindowInfo>
A promise containing active window info.

all

all(): Promise<WindowInfo[]>

- Defined in window/index.ts:59
Get a list of all the windows and their information.

Returns Promise<WindowInfo[]>
A promise containing all window info.

getActiveWindowID

getActiveWindowID(): Promise<number>

- Defined in window/index.ts:75
Get current active window ID.

Returns Promise<number>
A promise contain active window ID.

listenActiveWindow

listenActiveWindow(callback: (windowInfo: WindowInfo) => void): Promise<Cancellable>

- Defined in window/index.ts:52
Receive notifications whenever the currently focused window changes.

Parameters
- callback: (windowInfo: WindowInfo) => void
  
  A function called when active window changes.
  - - (windowInfo: WindowInfo): void
    - Parameters
      - windowInfo: WindowInfo
      Returns void
Returns Promise<Cancellable>

listenAll

listenAll(callback: (windowEvent: WindowEvent) => void): Promise<Cancellable>

- Defined in window/index.ts:68
Receive a notification whenever a window is opened, closed, focused, unfocused, moved, resized, or its title changes. A window that is opened with focus will generate an Opened event and a Focused event.

Parameters
- callback: (windowEvent: WindowEvent) => void
  
  A function called when any window changes.
  - - (windowEvent: WindowEvent): void
    - Parameters
      - windowEvent: WindowEvent
      Returns void
Returns Promise<Cancellable>

Generated using TypeDoc