Class: Courier::Models::ElementalHTMLNode

Inherits:

ElementalBaseNode

• Object
• Internal::Type::BaseModel
• ElementalBaseNode
• Courier::Models::ElementalHTMLNode

Defined in:

lib/courier/models/elemental_html_node.rb,
sig/courier/models/elemental_html_node.rbs

Direct Known Subclasses

ElementalHTMLNodeWithType

Instance Attribute Summary

• #content ⇒ String

  Raw HTML string to render inside the notification.

• #locales ⇒ Hash{Symbol=>Courier::Models::LocaleItem}^?

  Region specific content.

Attributes inherited from ElementalBaseNode

#channels, #if_, #loop_, #ref

Instance Method Summary

• #initialize(content:, locales: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see ElementalHTMLNode for more details.

• #to_hash ⇒ { content: String, locales: Courier::Models::locales? }

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(content:, locales: nil) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::ElementalHTMLNode for more details.

Raw HTML string inside an Elemental document. When rendering a message, this node is turned into output only for the email channel; for other channels it produces no blocks.

Parameters:

• content (String) —

  Raw HTML string to render inside the notification.

• locales (Hash{Symbol=>Courier::Models::LocaleItem}, nil) (defaults to: nil) —

  Region specific content. See [locales docs](https://www.courier.com/docs/platfor

# File 'lib/courier/models/elemental_html_node.rb', line 20

Instance Attribute Details

#content ⇒ String

Raw HTML string to render inside the notification.

Parameters:

• _ (String)

Returns:

• (String)

# File 'lib/courier/models/elemental_html_node.rb', line 10

required :content, String

#locales ⇒ Hash{Symbol=>Courier::Models::LocaleItem}^?

Region specific content. See locales docs for more details.

Parameters:

• _ (Courier::Models::locales, nil)

Returns:

• (Hash{Symbol=>Courier::Models::LocaleItem}, nil)

# File 'lib/courier/models/elemental_html_node.rb', line 18

optional :locales, -> { Courier::Internal::Type::HashOf[Courier::LocaleItem] }, nil?: true

Instance Method Details

#to_hash ⇒ { content: String, locales: Courier::Models::locales? }

Returns:

• ({ content: String, locales: Courier::Models::locales? })

# File 'sig/courier/models/elemental_html_node.rbs', line 20

def to_hash: -> { content: String, locales: Courier::Models::locales? }