Class: Aws::Notifications::Types::MessageComponents

Inherits:

Struct

• Object
• Struct
• Aws::Notifications::Types::MessageComponents

Defined in:

gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb

Overview

Describes the components of a notification message.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #complete_description ⇒ String

  A complete summary with all possible relevant information.

• #dimensions ⇒ Array<Types::Dimension>

  A list of properties in key-value pairs.

• #headline ⇒ String

  A sentence long summary.

• #markup_description ⇒ String

  A rich description in Portable Text format, which you can convert to markup formats such as HTML, Markdown, or plain text.

• #paragraph_summary ⇒ String

  A paragraph long or multiple sentence summary.

Instance Attribute Details

#complete_description ⇒ String

A complete summary with all possible relevant information.

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2532

class MessageComponents < Struct.new(
  :headline,
  :paragraph_summary,
  :complete_description,
  :markup_description,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#dimensions ⇒ Array<Types::Dimension>

A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

Included dimensions, keys, and values are subject to change.

Returns:

• (Array<Types::Dimension>)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2532

class MessageComponents < Struct.new(
  :headline,
  :paragraph_summary,
  :complete_description,
  :markup_description,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#headline ⇒ String

A sentence long summary. For example, titles or an email subject line.

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2532

class MessageComponents < Struct.new(
  :headline,
  :paragraph_summary,
  :complete_description,
  :markup_description,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#markup_description ⇒ String

A rich description in Portable Text format, which you can convert to markup formats such as HTML, Markdown, or plain text. Channels that don't support rich rendering ignore this field and use the plain text components instead.

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2532

class MessageComponents < Struct.new(
  :headline,
  :paragraph_summary,
  :complete_description,
  :markup_description,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#paragraph_summary ⇒ String

A paragraph long or multiple sentence summary. For example, Amazon Q Developer in chat applications notifications.

Returns:

• (String)

# File 'gems/aws-sdk-notifications/lib/aws-sdk-notifications/types.rb', line 2532

class MessageComponents < Struct.new(
  :headline,
  :paragraph_summary,
  :complete_description,
  :markup_description,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end