Package com.vonage.client.users

Class ListUsersRequest.Builder

java.lang.Object

com.vonage.client.users.ListUsersRequest.Builder

Enclosing class:

ListUsersRequest

public static class ListUsersRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ListUsersRequest	build()	Builds the request.
ListUsersRequest.Builder	cursor(URI cursor)	The cursor to start returning results from. You are not expected to provide this manually.
ListUsersRequest.Builder	name(String name)	Find user by their name.
ListUsersRequest.Builder	order(ListUsersRequest.SortOrder order)	The order to return the results in.
ListUsersRequest.Builder	pageSize(int pageSize)	Number of records to return in the response.

Methods inherited from class java.lang.Object

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

Method Details

pageSize

public ListUsersRequest.Builder pageSize(int pageSize)

Number of records to return in the response. Maximum is 100, default is 10.

Parameters:

pageSize - Number of results to return.

Returns:

This builder.

order

public ListUsersRequest.Builder order(ListUsersRequest.SortOrder order)

The order to return the results in. Users are sorted by their creation time. Default is ascending - i.e. newest to oldest. Use ListUsersRequest.SortOrder.DESC to sort the results from oldest to newest.

Parameters:

order - The sort order for results as an enum.

Returns:

This builder.

name

public ListUsersRequest.Builder name(String name)

Find user by their name.

Parameters:

name - Unique user name.

Returns:

This builder.

cursor

public ListUsersRequest.Builder cursor(URI cursor)

The cursor to start returning results from.
You are not expected to provide this manually. Instead, this will be parsed from the response page's links. You need to provide the URL of the page. This can be obtained from HalPageResponse.getLinks(), on which you would then call either HalLinks.getNextUrl() or HalLinks.getPrevUrl() and pass it to this method.

Parameters:

cursor - Page link URL containing the "cursor" query parameter.

Returns:

This builder.

build

public ListUsersRequest build()

Builds the request.

Returns:

A new ListUsersRequest with this builder's properties.