Class Channel
- java.lang.Object
-
- com.courier.api.resources.send.types.Channel
-
public final class Channel extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classChannel.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Channel.Builderbuilder()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.lang.String>getIf()java.util.Optional<ChannelMetadata>getMetadata()java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>getOverride()java.util.Optional<java.util.List<java.lang.String>>getProviders()java.util.Optional<RoutingMethod>getRoutingMethod()java.util.Optional<Timeouts>getTimeouts()inthashCode()java.lang.StringtoString()
-
-
-
Method Detail
-
getBrandId
public java.util.Optional<java.lang.String> getBrandId()
- Returns:
- Id of the brand that should be used for rendering the message. If not specified, the brand configured as default brand will be used.
-
getProviders
public java.util.Optional<java.util.List<java.lang.String>> getProviders()
- Returns:
- A list of providers enabled for this channel. Courier will select one provider to send through unless routing_method is set to all.
-
getRoutingMethod
public java.util.Optional<RoutingMethod> getRoutingMethod()
- Returns:
- The method for selecting the providers to send the message with.
Single will send to one of the available providers for this channel,
all will send the message through all channels. Defaults to
single.
-
getIf
public java.util.Optional<java.lang.String> getIf()
- Returns:
- A JavaScript conditional expression to determine if the message should
be sent through the channel. Has access to the data and profile object.
For example,
data.name === profile.name
-
getTimeouts
public java.util.Optional<Timeouts> getTimeouts()
-
getOverride
public java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getOverride()
- Returns:
- Channel specific overrides.
-
getMetadata
public java.util.Optional<ChannelMetadata> getMetadata()
-
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 Channel.Builder builder()
-
-