Class ContentMessage
- java.lang.Object
-
- com.courier.api.resources.send.types.ContentMessage
-
- All Implemented Interfaces:
IBaseMessage,IBaseMessageSendTo
public final class ContentMessage extends java.lang.Object implements IBaseMessage, IBaseMessageSendTo
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceContentMessage._FinalStagestatic classContentMessage.Builderstatic interfaceContentMessage.ContentStage
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ContentMessage.ContentStagebuilder()booleanequals(java.lang.Object other)java.util.Map<java.lang.String,java.lang.Object>getAdditionalProperties()java.util.Optional<java.lang.String>getBrandId()java.util.Optional<java.util.Map<java.lang.String,Channel>>getChannels()ContentgetContent()java.util.Optional<MessageContext>getContext()java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>getData()java.util.Optional<Delay>getDelay()java.util.Optional<Expiry>getExpiry()java.util.Optional<MessageMetadata>getMetadata()java.util.Optional<java.util.Map<java.lang.String,MessageProvidersType>>getProviders()java.util.Optional<Routing>getRouting()java.util.Optional<Timeout>getTimeout()java.util.Optional<MessageRecipient>getTo()inthashCode()java.lang.StringtoString()
-
-
-
Method Detail
-
getData
public java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getData()
- Specified by:
getDatain interfaceIBaseMessage- 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:
getBrandIdin interfaceIBaseMessage
-
getChannels
public java.util.Optional<java.util.Map<java.lang.String,Channel>> getChannels()
- Specified by:
getChannelsin interfaceIBaseMessage- 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:
getContextin interfaceIBaseMessage- Returns:
- Context to load with this recipient. Will override any context set on message.context.
-
getMetadata
public java.util.Optional<MessageMetadata> getMetadata()
- Specified by:
getMetadatain interfaceIBaseMessage- 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:
getProvidersin interfaceIBaseMessage- Returns:
- An object whose keys are valid provider identifiers which map to an object.
-
getRouting
public java.util.Optional<Routing> getRouting()
- Specified by:
getRoutingin interfaceIBaseMessage
-
getTimeout
public java.util.Optional<Timeout> getTimeout()
- Specified by:
getTimeoutin interfaceIBaseMessage- 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:
getDelayin interfaceIBaseMessage- Returns:
- Defines the time to wait before delivering the message.
-
getExpiry
public java.util.Optional<Expiry> getExpiry()
- Specified by:
getExpiryin interfaceIBaseMessage- 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."
-
getTo
public java.util.Optional<MessageRecipient> getTo()
- Specified by:
getToin interfaceIBaseMessageSendTo- Returns:
- The recipient or a list of recipients of the message
-
getContent
public Content getContent()
- Returns:
- Describes the content of the message in a way that will work for email, push, chat, or any channel. Either this or template must be specified.
-
equals
public boolean equals(java.lang.Object other)
- Overrides:
equalsin classjava.lang.Object
-
getAdditionalProperties
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
builder
public static ContentMessage.ContentStage builder()
-
-