Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.event
Class PrivateMessageEvent

java.lang.Object
  extended by com.jivesoftware.forum.event.PrivateMessageEvent
All Implemented Interfaces:
JiveEvent

public class PrivateMessageEvent
extends java.lang.Object
implements JiveEvent

An event for PrivateMessage objects. Certain event types will populate the params Map with additional objects as outlined below:

Event Type Extra Params
PRIVATE_MESSAGE_SENT None

Since:
4.0

Field Summary
static int PRIVATE_MESSAGE_SENT
          A private message was sent.
 
Constructor Summary
PrivateMessageEvent(int eventType, PrivateMessage privateMessage, java.util.Map params)
          Creates a new private message event.
 
Method Summary
 java.util.Date getDate()
          Returns the date (as a Date object) that the event was created.
 int getEventType()
          Returns the event type corresponding to the event.
 java.util.Map getParams()
          Returns a map of parameters which can be used to pass data to a listener.
 PrivateMessage getPrivateMessage()
          Returns the ForumMessage that the event corresponds to.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PRIVATE_MESSAGE_SENT

public static final int PRIVATE_MESSAGE_SENT
A private message was sent.

See Also:
Constant Field Values
Constructor Detail

PrivateMessageEvent

public PrivateMessageEvent(int eventType,
                           PrivateMessage privateMessage,
                           java.util.Map params)
Creates a new private message event.

Parameters:
eventType - the type of the message event.
privateMessage - the private message the event corresponds to.
params - parameters corresponding to the event.
Method Detail

getEventType

public int getEventType()
Description copied from interface: JiveEvent
Returns the event type corresponding to the event.

Specified by:
getEventType in interface JiveEvent
Returns:
the event type corresponding to the event.

getPrivateMessage

public PrivateMessage getPrivateMessage()
Returns the ForumMessage that the event corresponds to.

Returns:
the message the event corresponds to.

getParams

public java.util.Map getParams()
Description copied from interface: JiveEvent
Returns a map of parameters which can be used to pass data to a listener.

Specified by:
getParams in interface JiveEvent
Returns:
map of parameters which can be used to pass data to a listener.

getDate

public java.util.Date getDate()
Description copied from interface: JiveEvent
Returns the date (as a Date object) that the event was created.

Specified by:
getDate in interface JiveEvent
Returns:
the date (as a Date object) that the event was created.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.