Class: Aws::PinpointSMSVoiceV2::Types::RegistrationFieldDefinition

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::RegistrationFieldDefinition

Includes:

Structure

Defined in:

lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

Provides a description of the specified field.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #display_hints ⇒ Types::RegistrationFieldDisplayHints

  An array of RegistrationFieldDisplayHints objects for the field.

• #field_path ⇒ String

  The path to the registration form field.

• #field_requirement ⇒ String

  Specifies if the field for the registration form is required, conditional or optional.

• #field_type ⇒ String

  The type of field.

• #section_path ⇒ String

  The section path of the field.

• #select_validation ⇒ Types::SelectValidation

  The validation rules for a select field.

• #text_validation ⇒ Types::TextValidation

  The validation rules for a text field.

Instance Attribute Details

#display_hints ⇒ Types::RegistrationFieldDisplayHints

An array of RegistrationFieldDisplayHints objects for the field.

Returns:

• (Types::RegistrationFieldDisplayHints)

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

class RegistrationFieldDefinition < Struct.new(
  :section_path,
  :field_path,
  :field_type,
  :field_requirement,
  :select_validation,
  :text_validation,
  :display_hints)
  SENSITIVE = []
  include Aws::Structure
end

#field_path ⇒ String

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

Returns:

• (String)

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

class RegistrationFieldDefinition < Struct.new(
  :section_path,
  :field_path,
  :field_type,
  :field_requirement,
  :select_validation,
  :text_validation,
  :display_hints)
  SENSITIVE = []
  include Aws::Structure
end

#field_requirement ⇒ String

Specifies if the field for the registration form is required, conditional or optional.

Returns:

• (String)

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

class RegistrationFieldDefinition < Struct.new(
  :section_path,
  :field_path,
  :field_type,
  :field_requirement,
  :select_validation,
  :text_validation,
  :display_hints)
  SENSITIVE = []
  include Aws::Structure
end

#field_type ⇒ String

The type of field.

Returns:

• (String)

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

class RegistrationFieldDefinition < Struct.new(
  :section_path,
  :field_path,
  :field_type,
  :field_requirement,
  :select_validation,
  :text_validation,
  :display_hints)
  SENSITIVE = []
  include Aws::Structure
end

#section_path ⇒ String

The section path of the field.

Returns:

• (String)

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

class RegistrationFieldDefinition < Struct.new(
  :section_path,
  :field_path,
  :field_type,
  :field_requirement,
  :select_validation,
  :text_validation,
  :display_hints)
  SENSITIVE = []
  include Aws::Structure
end

#select_validation ⇒ Types::SelectValidation

The validation rules for a select field.

Returns:

• (Types::SelectValidation)

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

class RegistrationFieldDefinition < Struct.new(
  :section_path,
  :field_path,
  :field_type,
  :field_requirement,
  :select_validation,
  :text_validation,
  :display_hints)
  SENSITIVE = []
  include Aws::Structure
end

#text_validation ⇒ Types::TextValidation

The validation rules for a text field.

Returns:

• (Types::TextValidation)

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

class RegistrationFieldDefinition < Struct.new(
  :section_path,
  :field_path,
  :field_type,
  :field_requirement,
  :select_validation,
  :text_validation,
  :display_hints)
  SENSITIVE = []
  include Aws::Structure
end