|
Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AddressBookService
Provides ability to interace with the Private Message addressbook. Retrieve, add and remove users.
Method Summary | |
---|---|
void |
addUser(long userId,
java.lang.String usernameToAdd)
Adds a specified username to users addressbook. |
void |
addUsers(long userId,
long[] userIdsToAdd)
Adds a list of users to the Private Message addressbook of the specified user. |
User[] |
getRoster(long userID)
Retrieves a list of users contained within the specified users addressbook. |
void |
removeUser(long userId,
java.lang.String usernameToRemove)
Removes the specified username from a users Private Message addressbook. |
void |
removeUsers(long userId,
long[] userIdsToRemove)
Removes the specified list of users from a users Private Message addressbook. |
Method Detail |
---|
User[] getRoster(long userID) throws UserNotFoundException
userID
- of the the users addressbook to retrieve
UserNotFoundException
- is thrown if the userId specified is not a valid user.void addUser(long userId, java.lang.String usernameToAdd) throws UserNotFoundException
userId
- associated with the addressbook to be manipulatedusernameToAdd
- username of the user to add
UserNotFoundException
void addUsers(long userId, long[] userIdsToAdd) throws UserNotFoundException
userId
- associated with the addressbook to be manipulateduserIdsToAdd
- list of userIds to add to the addressbook
UserNotFoundException
void removeUser(long userId, java.lang.String usernameToRemove) throws UserNotFoundException
userId
- associated with the addressbook to be manipulatedusernameToRemove
- username to remove from the addressbook
UserNotFoundException
void removeUsers(long userId, long[] userIdsToRemove) throws UserNotFoundException
userId
- associated with the addressbook to be manipulateduserIdsToRemove
- list of user ids to remove from the addressbook
UserNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |