|
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 |
public interface Roster
A roster is a list of users that the user wishes to know if they are online. Rosters are similar to buddy groups in popular IM clients.
Method Summary | |
---|---|
void |
addUser(User user)
Add a user to the roster. |
int |
getOnlineUserCount()
Returns the number of users in the roster who are currently online. |
java.util.Iterator |
getOnlineUsers()
Returns an iterator of users in the roster who are currently online. |
java.util.Iterator |
getOnlineUsers(boolean ascending,
int sortField)
Returns an iterator of users sorted in the manner requested who are currently online. |
java.util.Iterator |
getOnlineUsers(boolean ascending,
int sortField,
int numResults)
Returns an iterator of users who are currently online matching the criteria given. |
int |
getTotalUserCount()
Returns the total number of users in the roster. |
User |
getUser()
Returns the user that this roster belongs to. |
java.util.Iterator |
getUsers()
Returns an iterator of users in this roster. |
boolean |
isRosterMember(User user)
Returns true if the specified user is a member of the roster, false otherwise. |
void |
removeUser(User user)
Remove a user from the roster. |
Method Detail |
---|
User getUser()
boolean isRosterMember(User user)
user
- the user object to check.
java.util.Iterator getUsers() throws UnauthorizedException
UnauthorizedException
int getTotalUserCount() throws UnauthorizedException
UnauthorizedException
int getOnlineUserCount() throws UnauthorizedException
UnauthorizedException
java.util.Iterator getOnlineUsers() throws UnauthorizedException
UnauthorizedException
java.util.Iterator getOnlineUsers(boolean ascending, int sortField)
ascending
- sort ascending if true, descending if false.sortField
- a valid sort field from the PresenceManager interface.
java.util.Iterator getOnlineUsers(boolean ascending, int sortField, int numResults)
ascending
- sort ascending if true, descending if false.sortField
- a valid sort field from the PresenceManager interface.numResults
- - the number of results to return.
void addUser(User user) throws UnauthorizedException
user
- the user to add to the roster.
UnauthorizedException
- if not the user or an administrator.void removeUser(User user) throws UnauthorizedException
user
- the user to remove from the roster.
UnauthorizedException
- if not the user or an administrator.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |