Module: Trycourier::Models::ElementalChannelNodeWithType::Type

Extended by:
Internal::Type::Enum
Defined in:
lib/trycourier/models/elemental_channel_node_with_type.rb

Constant Summary collapse

CHANNEL = 
:channel

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/trycourier/models/elemental_channel_node_with_type.rb', line 30

Instance Method Details

#initialize(type: nil) ⇒ Object

The channel element allows a notification to be customized based on which channel it is sent through. For example, you may want to display a detailed message when the notification is sent through email, and a more concise message in a push notification. Channel elements are only valid as top-level elements; you cannot nest channel elements. If there is a channel element specified at the top-level of the document, all sibling elements must be channel elements. Note: As an alternative, most elements support a ‘channel` property. Which allows you to selectively display an individual element on a per channel basis. See the [control flow docs](www.courier.com/docs/platform/content/elemental/control-flow/) for more details.

Parameters:



25
26
27
28
29
30
31
32
 
# File 'lib/trycourier/models/elemental_channel_node_with_type.rb', line 25

module Type
  extend Trycourier::Internal::Type::Enum

  CHANNEL = :channel

  # @!method self.values
  #   @return [Array<Symbol>]
end