Interface INotificationCenter

Interface for a notification center that manages dispatching and subscription of notifications.

interface INotificationCenter {
    dispatch(notification: INotification<any>): void;
    subscribe(
        name: string,
        handler: notification_api.onNotification<any>,
    ): IIdentifiable;
    unsubscribe(
        name: string,
        handler: notification_api.onNotification<any> | IIdentifiable,
    ): void;
}

Implemented by

NotificationCenter.NotificationCenter

Index

Methods

dispatch subscribe unsubscribe

Methods

dispatch

dispatch(notification: INotification<any>): void
Dispatches a notification to all subscribed handlers.
Parameters
- notification: INotification<any>
  The notification to dispatch.
Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/notification-api.ts:58

subscribe(
name: string,
handler: notification_api.onNotification<any>,
): IIdentifiable
Subscribes a handler to a specific notification name.
Parameters
- name: string
  The notification name.
- handler: notification_api.onNotification<any>
  The handler to invoke when the notification is dispatched.
Returns IIdentifiable
- Defined in hosanna-ui/src/hosanna-ui/lib/notification-api.ts:64

unsubscribe

unsubscribe(
name: string,
handler: notification_api.onNotification<any> | IIdentifiable,
): void
Unsubscribes a handler from a specific notification name.
Parameters
- name: string
  The notification name.
- handler: notification_api.onNotification<any> | IIdentifiable
  The handler to remove.
Returns void
- Defined in hosanna-ui/src/hosanna-ui/lib/notification-api.ts:70