|
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.opensymphony.xwork.ActionSupport
com.jivesoftware.base.action.JiveActionSupport
com.jivesoftware.forum.action.ForumActionSupport
com.jivesoftware.forum.action.OnlineAction
public class OnlineAction
An action that encapsulates all the logic for showing who is online is the forums.
Field Summary | |
---|---|
static int |
RANGE
Default number of online users to show on one page. |
static java.lang.String |
SORT_ONLINE_TIME
Flag for ordering online users by online time (from most to least). |
static java.lang.String |
SORT_USERNAME
Flag for ordering online users by username. |
Fields inherited from class com.jivesoftware.forum.action.ForumActionSupport |
---|
CANCEL, DISABLED, FATAL, NOTFOUND, SESSION_REFERRER_KEY, UNAUTHORIZED |
Fields inherited from class com.jivesoftware.base.action.JiveActionSupport |
---|
pageUser, request, response |
Fields inherited from class com.opensymphony.xwork.ActionSupport |
---|
LOG |
Fields inherited from interface com.opensymphony.xwork.Action |
---|
ERROR, INPUT, LOGIN, NONE, SUCCESS |
Constructor Summary | |
---|---|
OnlineAction()
|
Method Summary | |
---|---|
static long |
computeIdleTime(Presence presence)
Returns the idle time of a user in milliseconds. |
static long |
computeOnlineTime(Presence presence)
Returns the online time of a user in milliseconds. |
java.lang.String |
execute()
Default implementation of doExecute() method. |
java.util.Iterator |
getOnlineUsers()
Returns an Iterator of online users (sorted by username) in the current "window". |
PresenceManager |
getPresenceManager()
Returns a presence manager object with page user access permissions. |
int |
getRange()
|
ResultFilter |
getResultFilter()
Returns a Jive Forums result filter - this gives us a handle on the current index in the list and the number of items per page. |
java.lang.String |
getSort()
|
int |
getStart()
Returns the starting index in the item list. |
int |
getTotalItemCount()
Returns the total number of items our list/collection/whatever. |
void |
setRange(int range)
|
void |
setSort(java.lang.String sort)
|
void |
setStart(int start)
|
Methods inherited from class com.jivesoftware.forum.action.ForumActionSupport |
---|
getCanAttach, getCanCreateMessage, getCanCreatePoll, getCanCreatePoll, getCanCreateThread, getCanCreateThread, getCanEdit, getCanEditAttach, getCanEditPoll, getCanEditPoll, getCanEditProfile, getCanEditTags, getCanPostAnnounce, getCanPostAnnounce, getCanRead, getCanRead, getEntityDescriptor, getForumFactory, getPageUser, getReadStatus, getSkinProperty, getThemeName, isAdmin, isAdmin, isAuthor, isAuthor, isMessageModerationOn, isModerator, isModerator, isResourceInTheme, isSystemAdmin, isThreadModerationOn, setForumFactory, setUser |
Methods inherited from class com.jivesoftware.base.action.JiveActionSupport |
---|
getAuthToken, getGuestProperty, getJiveProperty, getLocales, getPageURL, getSession, getText, getText, getTimeZone, getTimeZones, isFailedLookup, isGuest, setAuthToken, setGuestProperty, setLoginAttributes, setPageUser, setServletRequest, setServletResponse |
Methods inherited from class com.opensymphony.xwork.ActionSupport |
---|
addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doDefault, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors, validate |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int RANGE
public static final java.lang.String SORT_USERNAME
public static final java.lang.String SORT_ONLINE_TIME
Constructor Detail |
---|
public OnlineAction()
Method Detail |
---|
public int getStart()
Pageable
getStart
in interface Pageable
public void setStart(int start)
public int getRange()
public void setRange(int range)
public java.lang.String getSort()
public void setSort(java.lang.String sort)
public int getTotalItemCount()
Pageable
getTotalItemCount
in interface Pageable
public ResultFilter getResultFilter()
Pageable
getResultFilter
in interface Pageable
public PresenceManager getPresenceManager()
public java.util.Iterator getOnlineUsers()
public java.lang.String execute()
ForumActionSupport
execute
in interface com.opensymphony.xwork.Action
execute
in class ForumActionSupport
public static long computeIdleTime(Presence presence)
presence
- a user's presence.
public static long computeOnlineTime(Presence presence)
presence
- a user's presence.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |