Package com.courier.api.resources.messages.requests

Class ListMessagesRequest

  • public final class ListMessagesRequest
extends java.lang.Object

    • Method Detail

      • getArchived

        public java.util.Optional<java.lang.Boolean> getArchived()
        Returns:
        A boolean value that indicates whether archived messages should be included in the response.

      • getCursor

        public java.util.Optional<java.lang.String> getCursor()
        Returns:
        A unique identifier that allows for fetching the next set of messages.

      • getEvent

        public java.util.Optional<java.lang.String> getEvent()
        Returns:
        A unique identifier representing the event that was used to send the event.

      • getList

        public java.util.Optional<java.lang.String> getList()
        Returns:
        A unique identifier representing the list the message was sent to.

      • getMessageId

        public java.util.Optional<java.lang.String> getMessageId()
        Returns:
        A unique identifier representing the message_id returned from either /send or /send/list.

      • getNotification

        public java.util.Optional<java.lang.String> getNotification()
        Returns:
        A unique identifier representing the notification that was used to send the event.

      • getProvider

        public java.util.Optional<java.lang.String> getProvider()
        Returns:
        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.

      • getRecipient

        public java.util.Optional<java.lang.String> getRecipient()
        Returns:
        A unique identifier representing the recipient associated with the requested profile.

      • getStatus

        public java.util.Optional<java.lang.String> getStatus()
        Returns:
        An indicator of the current status of the message. Allows multiple values to be set in query parameters.

      • getTag

        public java.util.Optional<java.lang.String> getTag()
        Returns:
        A tag placed in the metadata.tags during a notification send. Allows multiple values to be set in query parameters.

      • getTags

        public java.util.Optional<java.lang.String> getTags()
        Returns:
        A comma delimited list of 'tags'. Messages will be returned if they match any of the tags passed in.

      • getTenantId

        public java.util.Optional<java.lang.String> getTenantId()
        Returns:
        Messages sent with the context of a Tenant

      • getEnqueuedAfter

        public java.util.Optional<java.lang.String> getEnqueuedAfter()
        Returns:
        The enqueued datetime of a message to filter out messages received before.

      • getTraceId

        public java.util.Optional<java.lang.String> getTraceId()
        Returns:
        The unique identifier used to trace the requests

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object