Interface INotifier

INotifier The interface definition for a PureMVC Notifier.

MacroCommand, Command, Mediator and Proxy all have a need to send Notifications.

The INotifier interface provides a common method called sendNotification that relieves implementation code of the necessity to actually construct Notifications.

The Notifier class, which all the above-mentioned classes extend, also provides an initialized reference to the Facade Multiton, which is required for the convenience method for sending Notifications, but also eases implementation as these classes have frequent Facade interactions and usually require access to the facade anyway.

INotifier

interface INotifier {
    initializeNotifier(key: string): void;
    sendNotification(notificationName: string, body?: any, type?: string): void;
}

Hierarchy (view full)

Implemented by

Methods

initializeNotifier sendNotification

Methods

initializeNotifier

  • initializeNotifier(key): void

  • Initialize this INotifier instance.

    This is how a Notifier get to Calls to sendNotification or to access the facade will fail until after this method has been called.

    Parameters

    • key: string

      The key used to initialize the notifier.

    Returns void

sendNotification

  • sendNotification(notificationName, body?, type?): void

  • Send a INotification.

    Convenience method to prevent having to construct new notification instances in our implementation code.

    Parameters

    • notificationName: string

      The name of the notification to send.

    • Optionalbody: any

      Optional data associated with the notification.

    • Optionaltype: string

      Optional type of the notification.

    Returns void

Settings

Member Visibility

On This Page

Methods