Interface NotificationService

The NotificationService allows any part of the application to emit notifications to the user.

You can inject an instance of this service by referencing the interface name notifier.NotificationService.

interface NotificationService {
    closeAll(): void;
    error(options: SimpleNotificationOptions): void;
    info(options: SimpleNotificationOptions): void;
    notify(options: NotificationOptions): void;
    success(options: SimpleNotificationOptions): void;
    warning(options: SimpleNotificationOptions): void;
}

Hierarchy (View Summary)

DeclaredService<"notifier.NotificationService">
- NotificationService

Index

Methods

closeAll error info notify success warning

Methods

closeAll

closeAll(): void
Closes all active notifications.

Returns void
- Defined in notifier/api.ts:73

error

error(options: SimpleNotificationOptions): void
Emits an error notification. Same as notify with type: "error".
Parameters
- options: SimpleNotificationOptions
Returns void
- Defined in notifier/api.ts:70

info

info(options: SimpleNotificationOptions): void
Emits an info notification. Same as notify with type: "info".
Parameters
- options: SimpleNotificationOptions
Returns void
- Defined in notifier/api.ts:64

notify

notify(options: NotificationOptions): void
Emits a new notification.

Notifications are shown by the <Notifier /> component, which must be present in your application.
Parameters
- options: NotificationOptions
  Options for the new notification.
Returns void
- Defined in notifier/api.ts:58

success

success(options: SimpleNotificationOptions): void
Emits a success notification. Same as notify with type: "success".
Parameters
- options: SimpleNotificationOptions
Returns void
- Defined in notifier/api.ts:61

warning

warning(options: SimpleNotificationOptions): void
Emits a warning notification. Same as notify with type: "warning".
Parameters
- options: SimpleNotificationOptions
Returns void
- Defined in notifier/api.ts:67