java.lang.Object
- com.courier.api.resources.send.types.TemplateMessage.Builder

All Implemented Interfaces:: TemplateMessage._FinalStage, TemplateMessage.TemplateStage

Enclosing class:: TemplateMessage

public static final class TemplateMessage.Builder
extends java.lang.Object
implements TemplateMessage.TemplateStage, TemplateMessage._FinalStage

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TemplateMessage._FinalStage`	`brandId(java.lang.String brandId)`
`TemplateMessage._FinalStage`	`brandId(java.util.Optional<java.lang.String> brandId)`
`TemplateMessage`	`build()`
`TemplateMessage._FinalStage`	`channels(java.util.Map<java.lang.String,Channel> channels)`	"Define run-time configuration for one or more channels.
`TemplateMessage._FinalStage`	`channels(java.util.Optional<java.util.Map<java.lang.String,Channel>> channels)`
`TemplateMessage._FinalStage`	`context(MessageContext context)`	Context to load with this recipient.
`TemplateMessage._FinalStage`	`context(java.util.Optional<MessageContext> context)`
`TemplateMessage._FinalStage`	`data(java.util.Map<java.lang.String,java.lang.Object> data)`	An arbitrary object that includes any data you want to pass to the message.
`TemplateMessage._FinalStage`	`data(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> data)`
`TemplateMessage._FinalStage`	`delay(Delay delay)`	Defines the time to wait before delivering the message.
`TemplateMessage._FinalStage`	`delay(java.util.Optional<Delay> delay)`
`TemplateMessage._FinalStage`	`expiry(Expiry expiry)`	"Expiry allows you to set an absolute or relative time in which a message expires.
`TemplateMessage._FinalStage`	`expiry(java.util.Optional<Expiry> expiry)`
`TemplateMessage.Builder`	`from(TemplateMessage other)`
`TemplateMessage._FinalStage`	`metadata(MessageMetadata metadata)`	Metadata such as utm tracking attached with the notification through this channel.
`TemplateMessage._FinalStage`	`metadata(java.util.Optional<MessageMetadata> metadata)`
`TemplateMessage._FinalStage`	`preferences(MessagePreferences preferences)`
`TemplateMessage._FinalStage`	`preferences(java.util.Optional<MessagePreferences> preferences)`
`TemplateMessage._FinalStage`	`providers(java.util.Map<java.lang.String,MessageProvidersType> providers)`	An object whose keys are valid provider identifiers which map to an object.
`TemplateMessage._FinalStage`	`providers(java.util.Optional<java.util.Map<java.lang.String,MessageProvidersType>> providers)`
`TemplateMessage._FinalStage`	`routing(Routing routing)`
`TemplateMessage._FinalStage`	`routing(java.util.Optional<Routing> routing)`
`TemplateMessage._FinalStage`	`template(java.lang.String template)`	The id of the notification template to be rendered and sent to the recipient(s).
`TemplateMessage._FinalStage`	`timeout(Timeout timeout)`	Time in ms to attempt the channel before failing over to the next available channel.
`TemplateMessage._FinalStage`	`timeout(java.util.Optional<Timeout> timeout)`
`TemplateMessage._FinalStage`	`to(MessageRecipient to)`	The recipient or a list of recipients of the message
`TemplateMessage._FinalStage`	`to(java.util.Optional<MessageRecipient> to)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - from
```
public TemplateMessage.Builder from(TemplateMessage other)
```
    Specified by:
    
    from in interface TemplateMessage.TemplateStage
  - template
```
public TemplateMessage._FinalStage template(java.lang.String template)
```
    The id of the notification template to be rendered and sent to the recipient(s). This field or the content field must be supplied.
    
    Specified by:
    
    template in interface TemplateMessage.TemplateStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - to
```
public TemplateMessage._FinalStage to(MessageRecipient to)
```
    The recipient or a list of recipients of the message
    
    Specified by:
    
    to in interface TemplateMessage._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - to
```
public TemplateMessage._FinalStage to(java.util.Optional<MessageRecipient> to)
```
    Specified by:
    
    to in interface TemplateMessage._FinalStage
  - expiry
```
public TemplateMessage._FinalStage expiry(Expiry expiry)
```
    "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."
    
    Specified by:
    
    expiry in interface TemplateMessage._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - expiry
```
public TemplateMessage._FinalStage expiry(java.util.Optional<Expiry> expiry)
```
    Specified by:
    
    expiry in interface TemplateMessage._FinalStage
  - delay
```
public TemplateMessage._FinalStage delay(Delay delay)
```
    Defines the time to wait before delivering the message. You can specify one of the following options. Duration with the number of milliseconds to delay. Until with an ISO 8601 timestamp that specifies when it should be delivered. Until with an OpenStreetMap opening_hours-like format that specifies the Delivery Window (e.g., 'Mo-Fr 08:00-18:00pm')
    
    Specified by:
    
    delay in interface TemplateMessage._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - delay
```
public TemplateMessage._FinalStage delay(java.util.Optional<Delay> delay)
```
    Specified by:
    
    delay in interface TemplateMessage._FinalStage
  - timeout
```
public TemplateMessage._FinalStage timeout(Timeout timeout)
```
    Time in ms to attempt the channel before failing over to the next available channel.
    
    Specified by:
    
    timeout in interface TemplateMessage._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - timeout
```
public TemplateMessage._FinalStage timeout(java.util.Optional<Timeout> timeout)
```
    Specified by:
    
    timeout in interface TemplateMessage._FinalStage
  - routing
```
public TemplateMessage._FinalStage routing(Routing routing)
```
    Specified by:
    
    routing in interface TemplateMessage._FinalStage
  - routing
```
public TemplateMessage._FinalStage routing(java.util.Optional<Routing> routing)
```
    Specified by:
    
    routing in interface TemplateMessage._FinalStage
  - providers
```
public TemplateMessage._FinalStage providers(java.util.Map<java.lang.String,MessageProvidersType> providers)
```
    An object whose keys are valid provider identifiers which map to an object.
    
    Specified by:
    
    providers in interface TemplateMessage._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - providers
```
public TemplateMessage._FinalStage providers(java.util.Optional<java.util.Map<java.lang.String,MessageProvidersType>> providers)
```
    Specified by:
    
    providers in interface TemplateMessage._FinalStage
  - preferences
```
public TemplateMessage._FinalStage preferences(MessagePreferences preferences)
```
    Specified by:
    
    preferences in interface TemplateMessage._FinalStage
  - preferences
```
public TemplateMessage._FinalStage preferences(java.util.Optional<MessagePreferences> preferences)
```
    Specified by:
    
    preferences in interface TemplateMessage._FinalStage
  - metadata
```
public TemplateMessage._FinalStage metadata(MessageMetadata metadata)
```
    Metadata such as utm tracking attached with the notification through this channel.
    
    Specified by:
    
    metadata in interface TemplateMessage._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - metadata
```
public TemplateMessage._FinalStage metadata(java.util.Optional<MessageMetadata> metadata)
```
    Specified by:
    
    metadata in interface TemplateMessage._FinalStage
  - context
```
public TemplateMessage._FinalStage context(MessageContext context)
```
    Context to load with this recipient. Will override any context set on message.context.
    
    Specified by:
    
    context in interface TemplateMessage._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - context
```
public TemplateMessage._FinalStage context(java.util.Optional<MessageContext> context)
```
    Specified by:
    
    context in interface TemplateMessage._FinalStage
  - channels
```
public TemplateMessage._FinalStage channels(java.util.Map<java.lang.String,Channel> channels)
```
    "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."
    
    Specified by:
    
    channels in interface TemplateMessage._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - channels
```
public TemplateMessage._FinalStage channels(java.util.Optional<java.util.Map<java.lang.String,Channel>> channels)
```
    Specified by:
    
    channels in interface TemplateMessage._FinalStage
  - brandId
```
public TemplateMessage._FinalStage brandId(java.lang.String brandId)
```
    Specified by:
    
    brandId in interface TemplateMessage._FinalStage
  - brandId
```
public TemplateMessage._FinalStage brandId(java.util.Optional<java.lang.String> brandId)
```
    Specified by:
    
    brandId in interface TemplateMessage._FinalStage
  - data
```
public TemplateMessage._FinalStage data(java.util.Map<java.lang.String,java.lang.Object> data)
```
    An arbitrary object that includes any data you want to pass to the message. The data will populate the corresponding template or elements variables.
    
    Specified by:
    
    data in interface TemplateMessage._FinalStage
    
    Returns:
    
    Reference to this so that method calls can be chained together.
  - data
```
public TemplateMessage._FinalStage data(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> data)
```
    Specified by:
    
    data in interface TemplateMessage._FinalStage
  - build
```
public TemplateMessage build()
```
    Specified by:
    
    build in interface TemplateMessage._FinalStage

Class TemplateMessage.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

from

template

to

to

expiry

expiry

delay

delay

timeout

timeout

routing

routing

providers

providers

preferences

preferences

metadata

metadata

context

context

channels

channels

brandId

brandId

data

data

build