|
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.forum.webservices.server.AddressBookServiceImpl
public class AddressBookServiceImpl
Constructor Summary | |
---|---|
AddressBookServiceImpl()
|
Method Summary | |
---|---|
void |
addUser(long userId,
java.lang.String usernameToAdd)
Adds the specified username to the users addressbook. |
void |
addUsers(long userId,
long[] userIdsToAdd)
Adds a list of users to an addressbook. |
User[] |
getRoster(long userID)
Retrieves the private message addressbook for the specified user. |
void |
removeUser(long userId,
java.lang.String usernameToRemove)
Removes a username from the addressbook of a specified user. |
void |
removeUsers(long userId,
long[] userIdsToRemove)
Removes the list of specified userIds from a users addressbook. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AddressBookServiceImpl()
Method Detail |
---|
public User[] getRoster(long userID) throws UserNotFoundException
getRoster
in interface AddressBookService
userID
- of the user's addressbook to retrieve
UserNotFoundException
- if the user specified does not existpublic void addUser(long userId, java.lang.String usernameToAdd) throws UserNotFoundException
addUser
in interface AddressBookService
userId
- associated with the addressbook to manipulateusernameToAdd
- username of the user to add to this addressbook
UserNotFoundException
- if either the user associated with the userId or the usernameToAdd
does not existpublic void addUsers(long userId, long[] userIdsToAdd) throws UserNotFoundException
addUsers
in interface AddressBookService
userId
- associated with the addressbook to manipulateuserIdsToAdd
- list of userIds to add to the addressbook
UserNotFoundException
- if the user related to userId is not found.public void removeUser(long userId, java.lang.String usernameToRemove) throws UserNotFoundException
removeUser
in interface AddressBookService
userId
- of the associated addressbook to operate onusernameToRemove
- username to remove from the addressbook
UserNotFoundException
- if the userId or username is not a valid user.public void removeUsers(long userId, long[] userIdsToRemove) throws UserNotFoundException
removeUsers
in interface AddressBookService
userId
- of the associated addressbook to operate onuserIdsToRemove
- list of userIds to remove from the addressbook
UserNotFoundException
- if the userId specified is not a valid userId.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |