Interface AlertsApi

interface AlertsApi {
    configure(config: AlertsConfig): void;
    dismiss(id: string): void;
    error(text: string, config?: AlertConfig): Alert;
    info(text: string, config?: AlertConfig): Alert;
    update(id: string, text: string): void;
    warn(text: string, config?: AlertConfig): Alert;
}

Hierarchy (View Summary)

Api
- AlertsApi

Index

Methods

configure dismiss error info update warn

Methods

configure

configure(config: AlertsConfig): void
set configuration for the alerts component
Parameters
- config: AlertsConfig
  alerts configuration options
Returns void
- Defined in project/src/api/alerts-api.ts:26

dismiss

dismiss(id: string): void
dismiss an alert
Parameters
- id: string
  alert id
Returns void
- Defined in project/src/api/alerts-api.ts:63

error

error(text: string, config?: AlertConfig): Alert
create an error alert
Parameters
- text: string
  alert text
- Optionalconfig: AlertConfig
  alert configuration options
Returns Alert
the created alert
- Defined in project/src/api/alerts-api.ts:50

info

info(text: string, config?: AlertConfig): Alert
create an info alert
Parameters
- text: string
  alert text
- Optionalconfig: AlertConfig
  alert configuration options
Returns Alert
the created alert
- Defined in project/src/api/alerts-api.ts:42

update

update(id: string, text: string): void
change the text for an existing alert
Parameters
- id: string
  alert id
- text: string
  new alert text
Returns void
- Defined in project/src/api/alerts-api.ts:57

warn

warn(text: string, config?: AlertConfig): Alert
create a warning alert
Parameters
- text: string
  alert text
- Optionalconfig: AlertConfig
  alert configuration options
Returns Alert
the created alert
- Defined in project/src/api/alerts-api.ts:34