Package puremvc :: Module interfaces :: Class INotifier
[hide private]
[frames] | no frames]

Class INotifier

source code

object --+
         |
        INotifier
Known Subclasses:

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
Instance Methods [hide private]
 
sendNotification(self, notificationName, body=None, noteType=None)
Send a INotification.
source code
 
initializeNotifier(self, key)
Initialise this INotifier instance.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

sendNotification(self, notificationName, body=None, noteType=None)

source code 

Send a INotification.

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

Raises NotImplemented if subclass does not implement this method.

Parameters:
  • notificationName - the name of the notification to send
  • body - the body of the notification (optional)
  • noteType - the type of the notification (optional)

initializeNotifier(self, key)

source code 

Initialise 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.

Raises NotImplemented if subclass does not implement this method.

Parameters:
  • key - the multitonKey for this INotifier to use