Package com.vonage.client.users

Class UsersClient

java.lang.Object

com.vonage.client.users.UsersClient

public class UsersClient
extends Object

A client for talking to the Vonage Users API. The standard way to obtain an instance of this class is to use VonageClient.getUsersClient().

Constructor Summary

Constructors

Constructor	Description
UsersClient(HttpWrapper wrapper)

Method Summary

Modifier and Type	Method	Description
User	createUser(User user)	Create a new user.
void	deleteUser(String userId)	Delete a user.
User	getUser(String userId)	Retrieve a user.
User	getUserDetails(BaseUser minimalUser)	Convenience method that uses the metadata from the base user object to obtain all known fields about the user.
List<User>	getUserDetails(List<BaseUser> minimalUsers)	Convenience method that uses the metadata from the base users list to obtain all known fields about the users.
List<BaseUser>	listUsers()	Lists the first 100 users in the application, from newest to oldest.
ListUsersResponse	listUsers(ListUsersRequest request)	Lists users in the application based on the filter criteria.
User	updateUser(String userId, User user)	Update an existing user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UsersClient

public UsersClient(HttpWrapper wrapper)

Method Details

createUser

public User createUser(User user)
                throws UsersResponseException

Create a new user.

Parameters:

user - The properties for the user to be created with.

Returns:

The user which has been created.

Throws:

UsersResponseException - If there was an error processing the request.

updateUser

public User updateUser(String userId,
 User user)
                throws UsersResponseException

Update an existing user.

Parameters:

userId - Unique ID of the user to update.

user - The properties for the user to be updated with.

Returns:

The user which has been updated.

Throws:

UsersResponseException - If there was an error processing the request.

getUser

public User getUser(String userId)
             throws UsersResponseException

Retrieve a user.

Parameters:

userId - Unique ID of the user to retrieve.

Returns:

The corresponding user.

Throws:

UsersResponseException - If there was an error processing the request.

deleteUser

public void deleteUser(String userId)
                throws UsersResponseException

Delete a user.

Parameters:

userId - Unique ID of the user to delete.

Throws:

UsersResponseException - If there was an error processing the request.

listUsers

public ListUsersResponse listUsers(ListUsersRequest request)
                            throws UsersResponseException

Lists users in the application based on the filter criteria.

Parameters:

request - Optional parameters to customise the search results.

Returns:

The HAL response containing the users.

Throws:

UsersResponseException - If there was an error processing the request.

listUsers

public List<BaseUser> listUsers()
                         throws UsersResponseException

Lists the first 100 users in the application, from newest to oldest.
NOTE: The users returned from this method will only contain the name and ID, not the full record.

Returns:

The list of available users in creation order.

Throws:

UsersResponseException - If there was an error processing the request.

See Also:

• listUsers(ListUsersRequest)

getUserDetails

public User getUserDetails(BaseUser minimalUser)

Convenience method that uses the metadata from the base user object to obtain all known fields about the user.

Parameters:

minimalUser - The user metadata.

Returns:

A new User object with all known fields populated.

Throws:

UsersResponseException - If there was an error processing the request.

getUserDetails

public List<User> getUserDetails(List<BaseUser> minimalUsers)

Convenience method that uses the metadata from the base users list to obtain all known fields about the users. You may use this method to convert the minimal data returned from listUsers() or ListUsersResponse.getUsers() into fully populated records.

Parameters:

minimalUsers - The list of users' metadata.

Returns:

A list of users with all known fields populated in the same encounter order.

Throws:

UsersResponseException - If there was an error processing the request.