|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.event.MessageEvent
public class MessageEvent
An event for ForumMessage objects. Certain event types will populate the params Map with additional objects as outlined below:
Event Type | Extra Params |
---|---|
MESSAGE_ADDED | None |
MESSAGE_DELETED | None |
MESSAGE_MOVED | oldThreadID (Long) -- the ID of the thread
the message used to belong to. oldForumID (Long) -- the ID of the forum the message used to belong to. |
MESSAGE_MODIFIED | None |
MESSAGE_MODERATION_MODIFIED | oldModerationValue (Integer) -- the old
moderation value of the message. moderatorID (Long) -- the userID of user that made the moderation change, or -1 if userID is unknown or not present. |
MESSAGE_RATED | None |
Field Summary | |
---|---|
static int |
MESSAGE_ADDED
Message was added to the system. |
static int |
MESSAGE_DELETED
Message was deleted. |
static int |
MESSAGE_MODERATION_MODIFIED
The moderation value of the message was changed. |
static int |
MESSAGE_MODIFIED
The message was modified. |
static int |
MESSAGE_MOVED
The message was moved by becoming the root message of a new thread. |
static int |
MESSAGE_RATED
The message was rated. |
Constructor Summary | |
---|---|
MessageEvent(int eventType,
ForumMessage message,
java.util.Map params)
Creates a new 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. |
ForumMessage |
getMessage()
Returns the ForumMessage that the event corresponds to. |
java.util.Map |
getParams()
Returns a map of parameters which can be used to pass data to a listener. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int MESSAGE_ADDED
public static final int MESSAGE_DELETED
public static final int MESSAGE_MODIFIED
public static final int MESSAGE_MODERATION_MODIFIED
public static final int MESSAGE_RATED
public static final int MESSAGE_MOVED
Constructor Detail |
---|
public MessageEvent(int eventType, ForumMessage message, java.util.Map params)
eventType
- the type of the message event.message
- the message the event corresponds to.params
- parameters corresponding to the event.Method Detail |
---|
public int getEventType()
JiveEvent
getEventType
in interface JiveEvent
public ForumMessage getMessage()
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 |