Class MessageListParams
-
- All Implemented Interfaces:
-
com.courier.core.Params
public final class MessageListParams implements Params
Fetch the statuses of messages you've previously sent.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classMessageListParams.BuilderA builder for MessageListParams.
-
Method Summary
Modifier and Type Method Description final Optional<Boolean>archived()A boolean value that indicates whether archived messages should be included in the response. final Optional<String>cursor()A unique identifier that allows for fetching the next set of messages. final Optional<String>enqueuedAfter()The enqueued datetime of a message to filter out messages received before. final Optional<String>event()A unique identifier representing the event that was used to send the event. final Optional<String>list()A unique identifier representing the list the message was sent to. final Optional<String>messageId()A unique identifier representing the message_id returned from either /send or /send/list. final Optional<String>notification()A unique identifier representing the notification that was used to send the event. final Optional<List<String>>provider()The key assocated to the provider you want to filter on. final Optional<String>recipient()A unique identifier representing the recipient associated with the requested profile. final Optional<List<String>>status()An indicator of the current status of the message. final Optional<List<String>>tag()A tag placed in the metadata.tags during a notification send. final Optional<String>tags()A comma delimited list of 'tags'. final Optional<String>tenantId()Messages sent with the context of a Tenant final Optional<String>traceId()The unique identifier used to trace the requests final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final MessageListParams.BuildertoBuilder()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static MessageListParamsnone()final static MessageListParams.Builderbuilder()Returns a mutable builder for constructing an instance of MessageListParams. -
-
Method Detail
-
archived
final Optional<Boolean> archived()
A boolean value that indicates whether archived messages should be included in the response.
-
cursor
final Optional<String> cursor()
A unique identifier that allows for fetching the next set of messages.
-
enqueuedAfter
final Optional<String> enqueuedAfter()
The enqueued datetime of a message to filter out messages received before.
-
event
final Optional<String> event()
A unique identifier representing the event that was used to send the event.
-
list
final Optional<String> list()
A unique identifier representing the list the message was sent to.
-
messageId
final Optional<String> messageId()
A unique identifier representing the message_id returned from either /send or /send/list.
-
notification
final Optional<String> notification()
A unique identifier representing the notification that was used to send the event.
-
provider
final Optional<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.
-
recipient
final Optional<String> recipient()
A unique identifier representing the recipient associated with the requested profile.
-
status
final Optional<List<String>> status()
An indicator of the current status of the message. Allows multiple values to be set in query parameters.
-
tag
final Optional<List<String>> tag()
A tag placed in the metadata.tags during a notification send. Allows multiple values to be set in query parameters.
-
tags
final Optional<String> tags()
A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final MessageListParams.Builder toBuilder()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static MessageListParams none()
-
builder
final static MessageListParams.Builder builder()
Returns a mutable builder for constructing an instance of MessageListParams.
-
-
-
-