Package com.vonage.client.conversations

Class ListConversationsRequest

java.lang.Object

com.vonage.client.common.HalFilterRequest

com.vonage.client.conversations.ListConversationsRequest

All Implemented Interfaces:

QueryParamsRequest

public final class ListConversationsRequest
extends HalFilterRequest

Filters results for ConversationsClient.listConversations(ListConversationsRequest).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ListConversationsRequest.Builder

Field Summary

Fields inherited from class com.vonage.client.common.HalFilterRequest

cursor, endDate, order, page, pageSize, startDate

Method Summary

Modifier and Type	Method	Description
static ListConversationsRequest.Builder	builder()	Entry point for constructing an instance of this class.
protected String	formatTimestamp(Instant time)
String	getCursor()	The cursor to start returning results from.
Instant	getEndDate()	Filter records that occurred before this point in time.
SortOrder	getOrder()	Order to sort the results by.
Integer	getPageSize()	Number of results per page.
Instant	getStartDate()	Filter records that occurred after this point in time.
Map<String,String>	makeParams()	Internal method for serializing the fields of this class into query parameters.
protected Integer	validatePageSize(Integer pageSize)

Methods inherited from class com.vonage.client.common.HalFilterRequest

getPage, validatePage

Methods inherited from class java.lang.Object

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

Method Details

getStartDate

public Instant getStartDate()

Description copied from class: HalFilterRequest

Filter records that occurred after this point in time.

Overrides:

getStartDate in class HalFilterRequest

Returns:

The start timestamp for results, or null if unspecified.

getEndDate

public Instant getEndDate()

Description copied from class: HalFilterRequest

Filter records that occurred before this point in time.

Overrides:

getEndDate in class HalFilterRequest

Returns:

The end timestamp for results, or null if unspecified.

builder

public static ListConversationsRequest.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder.

validatePageSize

protected Integer validatePageSize(Integer pageSize)

Overrides:

validatePageSize in class HalFilterRequest

formatTimestamp

protected String formatTimestamp(Instant time)

getCursor

public String getCursor()

Description copied from class: HalFilterRequest

The cursor to start returning results from. This can be obtained from the URL in the relevant section from HalPageResponse.getLinks().

Overrides:

getCursor in class HalFilterRequest

Returns:

The page navigation cursor as a string, or null if unspecified.

makeParams

public Map<String,String> makeParams()

Description copied from interface: QueryParamsRequest

Internal method for serializing the fields of this class into query parameters. The Map should be mutable so that subclasses can add fields, otherwise the method or implementing class should be marked as final. Duplicate entries can be handled by mapping the key to a list of the entries.

Specified by:

makeParams in interface QueryParamsRequest

Overrides:

makeParams in class HalFilterRequest

Returns:

The query parameters as unique key-value pairs.

getPageSize

public Integer getPageSize()

Description copied from class: HalFilterRequest

Number of results per page.

Overrides:

getPageSize in class HalFilterRequest

Returns:

The page size as an integer, or null if not specified.

getOrder

public SortOrder getOrder()

Description copied from class: HalFilterRequest

Order to sort the results by.

Overrides:

getOrder in class HalFilterRequest

Returns:

The result sort order as an enum, or null if not specified.