|
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.base.event.PollEvent
public class PollEvent
An event for Poll objects. Certain event types will populate the params Map with additional objects as outlined below:
Event Type | Extra Params |
---|---|
POLL_CREATED | None |
POLL_DELETED | None |
VOTE_ADDED | user (User) -- the user that performed the voting action. |
ANONYMOUS_VOTE_ADDED | None |
VOTE_MODIFIED | user (User) -- the user that performed
the voting action. oldValue (Integer) -- the old vote value. |
ANONYMOUS_VOTE_MODIFIED | oldValue (Integer) -- the old vote value. |
VOTE_REMOVED | user (User) -- the user that performed the voting action. |
ANONYMOUS_VOTE_REMOVED | None |
Field Summary | |
---|---|
static int |
ANONYMOUS_VOTE_ADDED
An anonymous vote was added to the poll. |
static int |
ANONYMOUS_VOTE_MODIFIED
An anonymous vote was modified. |
static int |
ANONYMOUS_VOTE_REMOVED
An anonymous vote was removed. |
static int |
POLL_CREATED
A poll was created. |
static int |
POLL_DELETED
A poll is about to be deleted. |
static int |
VOTE_ADDED
A vote was added to the poll. |
static int |
VOTE_MODIFIED
A vote was modified. |
static int |
VOTE_REMOVED
A vote was removed. |
Constructor Summary | |
---|---|
PollEvent(int eventType,
Poll poll,
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. |
java.util.Map |
getParams()
Returns a map of parameters which can be used to pass data to a listener. |
Poll |
getPoll()
Returns the Poll 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 POLL_CREATED
public static final int POLL_DELETED
public static final int VOTE_ADDED
public static final int ANONYMOUS_VOTE_ADDED
public static final int VOTE_MODIFIED
public static final int ANONYMOUS_VOTE_MODIFIED
public static final int VOTE_REMOVED
public static final int ANONYMOUS_VOTE_REMOVED
Constructor Detail |
---|
public PollEvent(int eventType, Poll poll, java.util.Map params)
eventType
- the type of the message event.poll
- the poll the event corresponds to.params
- parameters corresponding to the event.Method Detail |
---|
public int getEventType()
JiveEvent
getEventType
in interface JiveEvent
public Poll getPoll()
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 |