Clearspace API (1.10.16) Core Javadocs

com.jivesoftware.community.event
Class PrivateMessageEventDispatcher

java.lang.Object
  extended by com.jivesoftware.community.event.PrivateMessageEventDispatcher

public class PrivateMessageEventDispatcher
extends java.lang.Object

Dispatcher for PrivateMessageEvents. Register PrivateMessageListeners at runtime using the addListener(PrivateMessageListener) method, or add a child Jive Property to the key "eventListeners.PrivateMessageListener" to register a listener that will persist across restarts.

For example, to register the com.acme.CustomPrivateMessageListener class as a persistent listener the following code could be used: // add persistent key to have the listener loaded and registered automatically at startup JiveGlobals.setJiveProperty("eventListeners.PrivateMessageListener.customPrivateMessageListener", "com.acme.CustomPrivateMessageListener.class"); // now add it for this runtime instance PrivateMessageEventDispatcher.addListener(new com.acme.CustomerPrivateMessageListener());


Method Summary
 void addListener(PrivateMessageListener listener)
           
static void destroy()
          Destroy dispatcher.
 void dispatchEvent(PrivateMessageEvent event)
           
static PrivateMessageEventDispatcher getInstance()
           
 void removeListener(PrivateMessageListener listener)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static PrivateMessageEventDispatcher getInstance()

addListener

public void addListener(PrivateMessageListener listener)

removeListener

public void removeListener(PrivateMessageListener listener)

destroy

public static void destroy()
Destroy dispatcher. Intended to be used primarily during testing.


dispatchEvent

public void dispatchEvent(PrivateMessageEvent event)

Clearspace Project Page

Copyright © 1999-2007 Jive Software.