Package com.vonage.client.conversations

Class ListUserConversationsRequest

java.lang.Object
com.vonage.client.common.HalFilterRequest
com.vonage.client.conversations.ListUserConversationsRequest
All Implemented Interfaces:
QueryParamsRequest
public final class ListUserConversationsRequest extends HalFilterRequest
Represents filter options for ConversationsClient.listUserConversations(String, ListUserConversationsRequest).

  • Field Details

    • userId

      protected String userId

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

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

    • getState

      public MemberState getState()
      Only include conversations with this member state.
      Returns:
      The state to filter by, or null if not specified.

    • getOrderBy

      public OrderBy getOrderBy()
      Determines how the results should be compared and ordered.
      Returns:
      The result ordering strategy, or null if not specified.

    • getIncludeCustomData

      public Boolean getIncludeCustomData()
      Whether to include custom data in the responses.
      Returns:
      true if custom data should be included, or null if not specified.

    • builder

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