|
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.base.RosterProxy
public class RosterProxy
Protection proxy for the Roster interface. It restricts access of certain methods to those that have the proper permissions to administer this object.
Constructor Summary | |
---|---|
RosterProxy(Roster roster,
AuthToken authToken,
Permissions permissions)
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RosterProxy(Roster roster, AuthToken authToken, Permissions permissions)
Method Detail |
---|
public User getUser()
Roster
getUser
in interface Roster
public boolean isRosterMember(User user)
Roster
isRosterMember
in interface Roster
user
- the user object to check.
public java.util.Iterator getUsers() throws UnauthorizedException
Roster
getUsers
in interface Roster
UnauthorizedException
public int getTotalUserCount() throws UnauthorizedException
Roster
getTotalUserCount
in interface Roster
UnauthorizedException
public int getOnlineUserCount() throws UnauthorizedException
Roster
getOnlineUserCount
in interface Roster
UnauthorizedException
public java.util.Iterator getOnlineUsers() throws UnauthorizedException
Roster
getOnlineUsers
in interface Roster
UnauthorizedException
public java.util.Iterator getOnlineUsers(boolean ascending, int sortField)
Roster
getOnlineUsers
in interface Roster
ascending
- sort ascending if true, descending if false.sortField
- a valid sort field from the PresenceManager interface.
public java.util.Iterator getOnlineUsers(boolean ascending, int sortField, int numResults)
Roster
getOnlineUsers
in interface Roster
ascending
- sort ascending if true, descending if false.sortField
- a valid sort field from the PresenceManager interface.numResults
- - the number of results to return.
public void addUser(User user) throws UnauthorizedException
Roster
addUser
in interface Roster
user
- the user to add to the roster.
UnauthorizedException
- if not the user or an administrator.public void removeUser(User user) throws UnauthorizedException
Roster
removeUser
in interface Roster
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 |