Package com.courier.api.resources.bulk.types

Class InboundBulkTemplateMessage

  • All Implemented Interfaces:
    IBaseMessage
    public final class InboundBulkTemplateMessage
extends java.lang.Object
implements IBaseMessage

    • Method Detail

      • getData

        public java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>> getData()
        Specified by:
        getData in interface IBaseMessage
        Returns:
        An arbitrary object that includes any data you want to pass to the message. The data will populate the corresponding template or elements variables.

      • getBrandId

        public java.util.Optional<java.lang.String> getBrandId()
        Specified by:
        getBrandId in interface IBaseMessage

      • getChannels

        public java.util.Optional<java.util.Map<java.lang.String,​Channel>> getChannels()
        Specified by:
        getChannels in interface IBaseMessage
        Returns:
        "Define run-time configuration for one or more channels. If you don't specify channels, the default configuration for each channel will be used. Valid ChannelId's are: email, sms, push, inbox, direct_message, banner, and webhook."

      • getContext

        public java.util.Optional<MessageContext> getContext()
        Specified by:
        getContext in interface IBaseMessage
        Returns:
        Context to load with this recipient. Will override any context set on message.context.

      • getMetadata

        public java.util.Optional<MessageMetadata> getMetadata()
        Specified by:
        getMetadata in interface IBaseMessage
        Returns:
        Metadata such as utm tracking attached with the notification through this channel.

      • getProviders

        public java.util.Optional<java.util.Map<java.lang.String,​MessageProvidersType>> getProviders()
        Specified by:
        getProviders in interface IBaseMessage
        Returns:
        An object whose keys are valid provider identifiers which map to an object.

      • getTimeout

        public java.util.Optional<Timeout> getTimeout()
        Specified by:
        getTimeout in interface IBaseMessage
        Returns:
        Time in ms to attempt the channel before failing over to the next available channel.

      • getDelay

        public java.util.Optional<Delay> getDelay()
        Specified by:
        getDelay in interface IBaseMessage
        Returns:
        Defines the time to wait before delivering the message.

      • getExpiry

        public java.util.Optional<Expiry> getExpiry()
        Specified by:
        getExpiry in interface IBaseMessage
        Returns:
        "Expiry allows you to set an absolute or relative time in which a message expires. Note: This is only valid for the Courier Inbox channel as of 12-08-2022."

      • getTemplate

        public java.lang.String getTemplate()
        Returns:
        The id of the notification template to be rendered and sent to the recipient(s). This field or the content field must be supplied.

      • 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