Package com.vonage.client.conversations

Class ListEventsRequest.Builder

java.lang.Object

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

com.vonage.client.conversations.ListEventsRequest.Builder

Enclosing class:

ListEventsRequest

public static final class ListEventsRequest.Builder
extends HalFilterRequest.Builder<ListEventsRequest,ListEventsRequest.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
ListEventsRequest	build()	Builds the ListEventsRequest.
ListEventsRequest.Builder	endId(int endId)	The ID to stop returning events at.
ListEventsRequest.Builder	eventType(EventType eventType)	The type of event to search for.
ListEventsRequest.Builder	excludeDeletedEvents(boolean excludeDeletedEvents)	Whether to exclude deleted events from the results.
ListEventsRequest.Builder	startId(int startId)	The ID to start returning events at.

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

endDate, page, startDate

Methods inherited from class java.lang.Object

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

Method Details

excludeDeletedEvents

public ListEventsRequest.Builder excludeDeletedEvents(boolean excludeDeletedEvents)

Whether to exclude deleted events from the results.

Parameters:

excludeDeletedEvents - true to exclude deleted events, or null if unspecified.

Returns:

This builder.

startId

public ListEventsRequest.Builder startId(int startId)

The ID to start returning events at.

Parameters:

startId - The start ID as an int.

Returns:

This builder.

endId

public ListEventsRequest.Builder endId(int endId)

The ID to stop returning events at.

Parameters:

endId - The end ID as an int.

Returns:

This builder.

eventType

public ListEventsRequest.Builder eventType(EventType eventType)

The type of event to search for. Does not currently support custom events.

Parameters:

eventType - The event type to search for as an enum.

Returns:

This builder.

build

public ListEventsRequest build()

Builds the ListEventsRequest.

Specified by:

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

Returns:

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