|
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 ProfileService
Provides a webservice for managing user's, avatar's, and status levels.
Method Summary | |
---|---|
User |
createUser(java.lang.String username,
java.lang.String password,
java.lang.String email)
Create a new user. |
void |
deleteUser(long userID)
Delete the user with the specified id. |
void |
deleteUserProperty(java.lang.String name,
long userID)
Delete an extended property from a user. |
User |
getUser(long id)
Returns a user by its id. |
User |
getUserByEmailAddress(java.lang.String emailAddress)
Returns a user object corresponding to the email address given. |
User |
getUserByUsername(java.lang.String username)
Returns a user by its username. |
int |
getUserCount()
Returns the number of users in the system. |
Property[] |
getUserProperties(long userID)
Return all extended properties for the user with the specified id. |
User[] |
getUsers()
Returns the IDs of the first 1000 users. |
User[] |
getUsersBounded(int startIndex,
int numResults)
Returns the IDs of users begining at startIndex and until the number results equals numResults. |
User[] |
getUsersByEmailAddress(java.lang.String emailAddress)
Returns an array user objects corresponding to the email address given. |
void |
setUserProperty(java.lang.String name,
java.lang.String value,
long userID)
Set an extended property for a user. |
void |
updateUser(User user)
Used to update user information in the system. |
Method Detail |
---|
User getUser(long id) throws UserNotFoundException
id
- The id of the user.
UserNotFoundException
User getUserByUsername(java.lang.String username) throws UserNotFoundException
username
- The username of the user.
UserNotFoundException
void updateUser(User user) throws UserNotFoundException
user
- User information to update.
UserNotFoundException
User createUser(java.lang.String username, java.lang.String password, java.lang.String email) throws UserAlreadyExistsException
username
- The name of user.password
- The password for the user.email
- The email address of the user.
UserAlreadyExistsException
void deleteUser(long userID) throws UserNotFoundException
userID
- The id of the user to delete.
UserNotFoundException
Property[] getUserProperties(long userID) throws UserNotFoundException
userID
- The user's id.
UserNotFoundException
void setUserProperty(java.lang.String name, java.lang.String value, long userID) throws UserNotFoundException
name
- The name of the extended property.value
- The value of the extended property.userID
- The user to set an extended property for.
UserNotFoundException
void deleteUserProperty(java.lang.String name, long userID) throws UserNotFoundException
name
- Name of the extended property to delete.userID
- The id of the user to delete the extended property from.
UserNotFoundException
- Thrown if the specified user didn't exist.int getUserCount()
User[] getUsersBounded(int startIndex, int numResults)
startIndex
- The startIndex to grab results from.numResults
- The total number of results to be returned.
User[] getUsers()
User getUserByEmailAddress(java.lang.String emailAddress) throws UserNotFoundException
emailAddress
- The email address of the user.
UserNotFoundException
User[] getUsersByEmailAddress(java.lang.String emailAddress) throws UserNotFoundException
emailAddress
- The email address of the user.
UserNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |