Package com.vonage.client.conversations

Class ListUserConversationsRequest.Builder

java.lang.Object

com.vonage.client.common.HalFilterRequest.Builder<ListUserConversationsRequest,ListUserConversationsRequest.Builder>

com.vonage.client.conversations.ListUserConversationsRequest.Builder

Enclosing class:

ListUserConversationsRequest

public static final class ListUserConversationsRequest.Builder
extends HalFilterRequest.Builder<ListUserConversationsRequest,ListUserConversationsRequest.Builder>

Field Summary

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

cursor, endDate, order, page, pageSize, startDate

Method Summary

Modifier and Type	Method	Description
ListUserConversationsRequest	build()	Builds the ListUserConversationsRequest.
ListUserConversationsRequest.Builder	includeCustomData(Boolean includeCustomData)	Whether to include custom data in the responses.
ListUserConversationsRequest.Builder	orderBy(OrderBy orderBy)	Determines how the results should be compared and ordered.
ListUserConversationsRequest.Builder	startDate(Instant startDate)	Filter records that occurred after this point in time.
ListUserConversationsRequest.Builder	state(MemberState state)	Only include conversations with this member state.

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

endDate, page

Methods inherited from class java.lang.Object

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

Method Details

startDate

public ListUserConversationsRequest.Builder startDate(Instant startDate)

Description copied from class: HalFilterRequest.Builder

Filter records that occurred after this point in time.

Overrides:

startDate in class HalFilterRequest.Builder<ListUserConversationsRequest,ListUserConversationsRequest.Builder>

Parameters:

startDate - The start timestamp for results.

Returns:

This builder.

state

public ListUserConversationsRequest.Builder state(MemberState state)

Only include conversations with this member state.

Parameters:

state - The state to filter by..

Returns:

This builder.

orderBy

public ListUserConversationsRequest.Builder orderBy(OrderBy orderBy)

Determines how the results should be compared and ordered.

Parameters:

orderBy - The result ordering strategy.

Returns:

This builder.

includeCustomData

public ListUserConversationsRequest.Builder includeCustomData(Boolean includeCustomData)

Whether to include custom data in the responses.

Parameters:

includeCustomData - true if custom data should be included.

Returns:

This builder.

build

public ListUserConversationsRequest build()

Builds the ListUserConversationsRequest.

Specified by:

build in class HalFilterRequest.Builder<ListUserConversationsRequest,ListUserConversationsRequest.Builder>

Returns:

An instance of ListUserConversationsRequest, populated with all fields from this builder.