Packageorg.puremvc.as3.multicore.interfaces
Interfacepublic interface INotifier
SubinterfacesICommand, IFacade, IMediator, IProxy
ImplementorsMacroCommand, Mediator, Notifier, Proxy, SimpleCommand

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 of the above mentioned classes extend, also provides an initialized reference to the Facade Singleton, which is required for the convienience method for sending Notifications, but also eases implementation as these classes have frequent Facade interactions and usually require access to the facade anyway.

See also

IFacade
INotification


Public Methods
 MethodDefined by
  
initializeNotifier(key:String):void
Initialize this INotifier instance.
INotifier
  
sendNotification(notificationName:String, body:Object = null, type:String = null):void
Send a INotification.
INotifier
Method detail
initializeNotifier()method
public function initializeNotifier(key:String):void

Initialize this INotifier instance.

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

Parameters
key:String — the multitonKey for this INotifier to use
sendNotification()method 
public function sendNotification(notificationName:String, body:Object = null, type:String = null):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
 
body:Object (default = null) — the body of the notification (optional)
 
type:String (default = null) — the type of the notification (optional)