|
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.ThreadEvent
public class ThreadEvent
An event for ForumThread objects. Certain event types will populate the params Map with additional objects as outlined below:
Event Type | Extra Params |
---|---|
THREAD_ADDED | None |
THREAD_DELETING | None |
THREAD_MOVED | oldForumID (Long) -- the ID of the forum the thread used to belong to. |
THREAD_MODERATION_MODIFIED | oldModerationValue (Integer) -- the old
moderation value of the thread. moderatorID (Long) -- the userID of user that made the moderation change, or -1 if userID is unknown or not present. |
Field Summary | |
---|---|
static int |
THREAD_ADDED
Thread was added to the system. |
static int |
THREAD_DELETING
Thread is about to be deleted. |
static int |
THREAD_MODERATION_MODIFIED
The moderation value of the thread was changed. |
static int |
THREAD_MOVED
Thread was moved to another forum. |
static int |
THREAD_RATED
The thread was rated. |
Constructor Summary | |
---|---|
ThreadEvent(int eventType,
ForumThread thread,
java.util.Map params)
Creates a new thread 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. |
ForumThread |
getThread()
Returns the ForumThread 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 THREAD_ADDED
public static final int THREAD_DELETING
public static final int THREAD_MOVED
public static final int THREAD_MODERATION_MODIFIED
public static final int THREAD_RATED
Constructor Detail |
---|
public ThreadEvent(int eventType, ForumThread thread, java.util.Map params)
eventType
- the type of the message event.thread
- the message the event corresponds to.params
- parameters corresponding to the event.Method Detail |
---|
public int getEventType()
JiveEvent
getEventType
in interface JiveEvent
public ForumThread getThread()
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 |