Interface AlertsApi

interface AlertsApi {
    onEvent$: Observable<AlertEvent>;
    dismiss(id: string): void;
    dismissAll(): void;
    error(message: string, config?: AlertConfig): string;
    info(message: string, config?: AlertConfig): string;
    warn(message: string, config?: AlertConfig): string;
}

Index

Properties

Methods

dismiss dismissAll error info warn

Properties

onEvent$

onEvent$: Observable<AlertEvent>

Emits an event whenever an alert is raised or dismissed.

Methods

dismiss

dismiss(id: string): void
Dismisses the alert with the given ID.
Parameters
- id: string
  The ID of the alert to dismiss.
Returns void
- Defined in src/session/alerts-api.ts:67

dismissAll

dismissAll(): void
Dismisses all currently active alerts.

Returns void
- Defined in src/session/alerts-api.ts:70

error

error(message: string, config?: AlertConfig): string
Raises an error alert.
Parameters
- message: string
  The message to display.
- Optionalconfig: AlertConfig
  Optional display configuration (e.g. auto-dismiss duration).
Returns string
The unique ID of the created alert.
- Defined in src/session/alerts-api.ts:60

info

info(message: string, config?: AlertConfig): string
Raises an info alert.
Parameters
- message: string
  The message to display.
- Optionalconfig: AlertConfig
  Optional display configuration (e.g. auto-dismiss duration).
Returns string
The unique ID of the created alert.
- Defined in src/session/alerts-api.ts:42

warn

warn(message: string, config?: AlertConfig): string
Raises a warning alert.
Parameters
- message: string
  The message to display.
- Optionalconfig: AlertConfig
  Optional display configuration (e.g. auto-dismiss duration).
Returns string
The unique ID of the created alert.
- Defined in src/session/alerts-api.ts:51