|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.event.PrivateMessageEvent
public class PrivateMessageEvent
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 |
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 |
---|
public static final int PRIVATE_MESSAGE_SENT
Constructor Detail |
---|
public PrivateMessageEvent(int eventType, PrivateMessage privateMessage, java.util.Map params)
eventType
- the type of the message event.privateMessage
- the private message the event corresponds to.params
- parameters corresponding to the event.Method Detail |
---|
public int getEventType()
JiveEvent
getEventType
in interface JiveEvent
public PrivateMessage getPrivateMessage()
public java.util.Map getParams()
JiveEvent
getParams
in interface JiveEvent
public java.util.Date getDate()
JiveEvent
getDate
in interface JiveEvent
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |