Class: Aws::PinpointSMSVoiceV2::Types::RegistrationFieldDisplayHints

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::RegistrationFieldDisplayHints

Includes:

Structure

Defined in:

lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

Provides help information on the registration field.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #documentation_link ⇒ String

  The link to the document the display hint is associated with.

• #documentation_title ⇒ String

  The title of the document the display hint is associated with.

• #example_text_value ⇒ String

  Example text of what the value of a field should contain.

• #long_description ⇒ String

  A full description of the display hint.

• #select_option_descriptions ⇒ Array<Types::SelectOptionDescription>

  An array of SelectOptionDescription objects.

• #short_description ⇒ String

  A short description of the display hint.

• #text_validation_description ⇒ String

  The validation rules for the text field.

• #title ⇒ String

  The title of the display hint.

Instance Attribute Details

#documentation_link ⇒ String

The link to the document the display hint is associated with.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4344

class RegistrationFieldDisplayHints < Struct.new(
  :title,
  :short_description,
  :long_description,
  :documentation_title,
  :documentation_link,
  :select_option_descriptions,
  :text_validation_description,
  :example_text_value)
  SENSITIVE = []
  include Aws::Structure
end

#documentation_title ⇒ String

The title of the document the display hint is associated with.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4344

class RegistrationFieldDisplayHints < Struct.new(
  :title,
  :short_description,
  :long_description,
  :documentation_title,
  :documentation_link,
  :select_option_descriptions,
  :text_validation_description,
  :example_text_value)
  SENSITIVE = []
  include Aws::Structure
end

#example_text_value ⇒ String

Example text of what the value of a field should contain.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4344

class RegistrationFieldDisplayHints < Struct.new(
  :title,
  :short_description,
  :long_description,
  :documentation_title,
  :documentation_link,
  :select_option_descriptions,
  :text_validation_description,
  :example_text_value)
  SENSITIVE = []
  include Aws::Structure
end

#long_description ⇒ String

A full description of the display hint.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4344

class RegistrationFieldDisplayHints < Struct.new(
  :title,
  :short_description,
  :long_description,
  :documentation_title,
  :documentation_link,
  :select_option_descriptions,
  :text_validation_description,
  :example_text_value)
  SENSITIVE = []
  include Aws::Structure
end

#select_option_descriptions ⇒ Array<Types::SelectOptionDescription>

An array of SelectOptionDescription objects.

Returns:

• (Array<Types::SelectOptionDescription>)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4344

class RegistrationFieldDisplayHints < Struct.new(
  :title,
  :short_description,
  :long_description,
  :documentation_title,
  :documentation_link,
  :select_option_descriptions,
  :text_validation_description,
  :example_text_value)
  SENSITIVE = []
  include Aws::Structure
end

#short_description ⇒ String

A short description of the display hint.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4344

class RegistrationFieldDisplayHints < Struct.new(
  :title,
  :short_description,
  :long_description,
  :documentation_title,
  :documentation_link,
  :select_option_descriptions,
  :text_validation_description,
  :example_text_value)
  SENSITIVE = []
  include Aws::Structure
end

#text_validation_description ⇒ String

The validation rules for the text field.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4344

class RegistrationFieldDisplayHints < Struct.new(
  :title,
  :short_description,
  :long_description,
  :documentation_title,
  :documentation_link,
  :select_option_descriptions,
  :text_validation_description,
  :example_text_value)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the display hint.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4344

class RegistrationFieldDisplayHints < Struct.new(
  :title,
  :short_description,
  :long_description,
  :documentation_title,
  :documentation_link,
  :select_option_descriptions,
  :text_validation_description,
  :example_text_value)
  SENSITIVE = []
  include Aws::Structure
end