Package com.vonage.client.conversations

Class ListEventsRequest

java.lang.Object
com.vonage.client.common.HalFilterRequest
com.vonage.client.conversations.ListEventsRequest
All Implemented Interfaces:
QueryParamsRequest
public class ListEventsRequest extends HalFilterRequest
Filters results for ConversationsClient.listEvents(String, ListEventsRequest).

  • Method Details

    • 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
      Returns:
      The query parameters as unique key-value pairs.

    • getExcludeDeletedEvents

      public Boolean getExcludeDeletedEvents()
      Whether to exclude deleted events from the results.
      Returns:
      true to exclude deleted events, or null if unspecified.

    • getStartId

      public Integer getStartId()
      The ID to start returning events at.
      Returns:
      The start ID as an Integer, or null if unspecified.

    • getEndId

      public Integer getEndId()
      The ID to stop returning events at.
      Returns:
      The end ID as an Integer, or null if unspecified.

    • getEventType

      public EventType getEventType()
      The type of event to search for. Does not currently support custom events.
      Returns:
      The event type to search for, or null if unspecified.

    • builder

      public static ListEventsRequest.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.

    • 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.