Class AlertManagerState

Hierarchy

AlertManagerState

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AlertManagerState(): AlertManagerState

Returns AlertManagerState

Properties

Protected activeAlerts

activeAlerts: {} = {}

Type declaration

[id: number]: AlertState

Protected alertId

alertId: number = 0

Methods

clear

clear(): void

- Defined in src/common/states/AlertManagerState.ts:68
Clear all alerts.

Returns void

dismiss

dismiss(key: null | number): void

- Defined in src/common/states/AlertManagerState.ts:58
Dismiss an alert.

Parameters
- key: null | number
Returns void

getActiveAlerts

getActiveAlerts(): {}

- Defined in src/common/states/AlertManagerState.ts:19
Returns {}
- [id: number]: AlertState

show

show(children: Children): number
show(attrs: AlertAttrs, children: Children): number
show(componentClass: typeof Alert, attrs: AlertAttrs, children: Children): number

- Defined in src/common/states/AlertManagerState.ts:28
Show an Alert in the alerts area.

Parameters
- children: Children
Returns number
The alert's ID, which can be used to dismiss the alert.
- Defined in src/common/states/AlertManagerState.ts:29
Parameters
- attrs: AlertAttrs
- children: Children
Returns number
- Defined in src/common/states/AlertManagerState.ts:30
Parameters
- componentClass: typeof Alert
- attrs: AlertAttrs
- children: Children
Returns number

Generated using TypeDoc version 0.22.10