Class WindowBlinkService

Service for blinking/flashing the application window to get user attention.

Index

Constructors

Properties

Methods

blinkBrowserWindow blinkDocumentTitle blinkElectronWindow blinkWindow blinkWithVisibilityAPI focusWindow getBlinkCapabilities isBlinkSupported

Constructors

constructor

new WindowBlinkService(): WindowBlinkService
Returns WindowBlinkService
- Defined in packages/ai-core/src/browser/window-blink-service.ts:38

Properties

`Private` isElectron

isElectron: boolean

Methods

`Private` blinkBrowserWindow

blinkBrowserWindow(agentName?): Promise<void>
Parameters
- Optional agentName: string
Returns Promise<void>
- Defined in packages/ai-core/src/browser/window-blink-service.ts:89

`Private` blinkDocumentTitle

blinkDocumentTitle(agentName?): Promise<void>
Parameters
- Optional agentName: string
Returns Promise<void>
- Defined in packages/ai-core/src/browser/window-blink-service.ts:97

`Private` blinkElectronWindow

blinkElectronWindow(agentName?): Promise<void>
Parameters
- Optional agentName: string
Returns Promise<void>
- Defined in packages/ai-core/src/browser/window-blink-service.ts:72

blinkWindow

blinkWindow(agentName?): Promise<WindowBlinkResult>
Blink/flash the window to get user attention. The implementation varies depending on the platform and environment.
Parameters
- Optional agentName: string
  Optional name of the agent to include in the blink notification
Returns Promise<WindowBlinkResult>
- Defined in packages/ai-core/src/browser/window-blink-service.ts:48

`Private` blinkWithVisibilityAPI

blinkWithVisibilityAPI(): void
Returns void
- Defined in packages/ai-core/src/browser/window-blink-service.ts:118

`Private` focusWindow

focusWindow(): void
Returns void
- Defined in packages/ai-core/src/browser/window-blink-service.ts:129

getBlinkCapabilities

getBlinkCapabilities(): {
    features: string[];
    method: "electron" | "browser" | "none";
    supported: boolean;
}
Get information about the blinking capabilities.

Returns {
    features: string[];
    method: "electron" | "browser" | "none";
    supported: boolean;
}
- features: string[]
- method: "electron" | "browser" | "none"
- supported: boolean
- Defined in packages/ai-core/src/browser/window-blink-service.ts:162

isBlinkSupported

isBlinkSupported(): boolean
Check if window blinking is supported in the current environment.

Returns boolean
- Defined in packages/ai-core/src/browser/window-blink-service.ts:149