Constructor Detail

Method Detail

• archived

   final MessageListParams.Builder archived(Boolean archived)

  A boolean value that indicates whether archived messages should be included in the response.

• archived

   final MessageListParams.Builder archived(Boolean archived)

  Alias for Builder.archived.

  This unboxed primitive overload exists for backwards compatibility.

• archived

   final MessageListParams.Builder archived(Optional<Boolean> archived)

  Alias for calling Builder.archived with archived.orElse(null).

• cursor

   final MessageListParams.Builder cursor(String cursor)

  A unique identifier that allows for fetching the next set of messages.

• cursor

   final MessageListParams.Builder cursor(Optional<String> cursor)

  Alias for calling Builder.cursor with cursor.orElse(null).

• enqueuedAfter

   final MessageListParams.Builder enqueuedAfter(String enqueuedAfter)

  The enqueued datetime of a message to filter out messages received before.

• enqueuedAfter

   final MessageListParams.Builder enqueuedAfter(Optional<String> enqueuedAfter)

  Alias for calling Builder.enqueuedAfter with enqueuedAfter.orElse(null).

• event

   final MessageListParams.Builder event(String event)

  A unique identifier representing the event that was used to send the event.

• event

   final MessageListParams.Builder event(Optional<String> event)

  Alias for calling Builder.event with event.orElse(null).

• list

   final MessageListParams.Builder list(String list)

  A unique identifier representing the list the message was sent to.

• list

   final MessageListParams.Builder list(Optional<String> list)

  Alias for calling Builder.list with list.orElse(null).

• messageId

   final MessageListParams.Builder messageId(String messageId)

  A unique identifier representing the message_id returned from either /send or /send/list.

• messageId

   final MessageListParams.Builder messageId(Optional<String> messageId)

  Alias for calling Builder.messageId with messageId.orElse(null).

• notification

   final MessageListParams.Builder notification(String notification)

  A unique identifier representing the notification that was used to send the event.

• notification

   final MessageListParams.Builder notification(Optional<String> notification)

  Alias for calling Builder.notification with notification.orElse(null).

• provider

   final MessageListParams.Builder provider(List<String> provider)

  The key assocated to the provider you want to filter on. E.g., sendgrid, inbox, twilio, slack, msteams, etc. Allows multiple values to be set in query parameters.

• provider

   final MessageListParams.Builder provider(Optional<List<String>> provider)

  Alias for calling Builder.provider with provider.orElse(null).

• addProvider

   final MessageListParams.Builder addProvider(String provider)

  Adds a single String to Builder.provider.

• recipient

   final MessageListParams.Builder recipient(String recipient)

  A unique identifier representing the recipient associated with the requested profile.

• recipient

   final MessageListParams.Builder recipient(Optional<String> recipient)

  Alias for calling Builder.recipient with recipient.orElse(null).

• status

   final MessageListParams.Builder status(List<String> status)

  An indicator of the current status of the message. Allows multiple values to be set in query parameters.

• status

   final MessageListParams.Builder status(Optional<List<String>> status)

  Alias for calling Builder.status with status.orElse(null).

• addStatus

   final MessageListParams.Builder addStatus(String status)

  Adds a single String to Builder.status.

• tag

   final MessageListParams.Builder tag(List<String> tag)

  A tag placed in the metadata.tags during a notification send. Allows multiple values to be set in query parameters.

• tag

   final MessageListParams.Builder tag(Optional<List<String>> tag)

  Alias for calling Builder.tag with tag.orElse(null).

• addTag

   final MessageListParams.Builder addTag(String tag)

  Adds a single String to Builder.tag.

• tags

   final MessageListParams.Builder tags(String tags)

  A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.

• tags

   final MessageListParams.Builder tags(Optional<String> tags)

  Alias for calling Builder.tags with tags.orElse(null).

• tenantId

   final MessageListParams.Builder tenantId(String tenantId)

  Messages sent with the context of a Tenant

• tenantId

   final MessageListParams.Builder tenantId(Optional<String> tenantId)

  Alias for calling Builder.tenantId with tenantId.orElse(null).

• traceId

   final MessageListParams.Builder traceId(String traceId)

  The unique identifier used to trace the requests

• traceId

   final MessageListParams.Builder traceId(Optional<String> traceId)

  Alias for calling Builder.traceId with traceId.orElse(null).

• additionalHeaders

   final MessageListParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final MessageListParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final MessageListParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final MessageListParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final MessageListParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final MessageListParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final MessageListParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final MessageListParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final MessageListParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final MessageListParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final MessageListParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final MessageListParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final MessageListParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final MessageListParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final MessageListParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final MessageListParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final MessageListParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final MessageListParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final MessageListParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final MessageListParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final MessageListParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final MessageListParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final MessageListParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final MessageListParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final MessageListParams build()

  Returns an immutable instance of MessageListParams.

  Further updates to this Builder will not mutate the returned instance.