Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs

com.jivesoftware.forum.webservices
Interface AddressBookService


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

getRoster

User[] getRoster(long userID)
                 throws UserNotFoundException
Retrieves a list of users contained within the specified users addressbook.

Parameters:
userID - of the the users addressbook to retrieve
Returns:
an array of users in the addressbook
Throws:
UserNotFoundException - is thrown if the userId specified is not a valid user.

addUser

void addUser(long userId,
             java.lang.String usernameToAdd)
             throws UserNotFoundException
Adds a specified username to users addressbook.

Parameters:
userId - associated with the addressbook to be manipulated
usernameToAdd - username of the user to add
Throws:
UserNotFoundException

addUsers

void addUsers(long userId,
              long[] userIdsToAdd)
              throws UserNotFoundException
Adds a list of users to the Private Message addressbook of the specified user.

Parameters:
userId - associated with the addressbook to be manipulated
userIdsToAdd - list of userIds to add to the addressbook
Throws:
UserNotFoundException

removeUser

void removeUser(long userId,
                java.lang.String usernameToRemove)
                throws UserNotFoundException
Removes the specified username from a users Private Message addressbook.

Parameters:
userId - associated with the addressbook to be manipulated
usernameToRemove - username to remove from the addressbook
Throws:
UserNotFoundException

removeUsers

void removeUsers(long userId,
                 long[] userIdsToRemove)
                 throws UserNotFoundException
Removes the specified list of users from a users Private Message addressbook.

Parameters:
userId - associated with the addressbook to be manipulated
userIdsToRemove - list of user ids to remove from the addressbook
Throws:
UserNotFoundException

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.