Class: Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb

Overview

Text input allows the business to provide a text value.

Defined Under Namespace

Modules: TextInputType

Instance Attribute Summary collapse

Instance Attribute Details

#additional_info ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::TextWithTooltip

Returns Additional info regarding the field to be displayed to the business. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip.

Returns:



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 609

class TextInput
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum specifying the type of the text input and how it should be rendered.
  module TextInputType
    # Default value. Will never be provided by the API.
    TEXT_INPUT_TYPE_UNSPECIFIED = 0

    # Used when a short text is expected. The field can be rendered as a
    # [text
    # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
    GENERIC_SHORT_TEXT = 1

    # Used when a longer text is expected. The field should be rendered as a
    # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
    GENERIC_LONG_TEXT = 2
  end
end

#aria_label ⇒ ::String

Returns Text to be used as the aria-label for the input.

Returns:

  • (::String) —

    Text to be used as the aria-label for the input.



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 609

class TextInput
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum specifying the type of the text input and how it should be rendered.
  module TextInputType
    # Default value. Will never be provided by the API.
    TEXT_INPUT_TYPE_UNSPECIFIED = 0

    # Used when a short text is expected. The field can be rendered as a
    # [text
    # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
    GENERIC_SHORT_TEXT = 1

    # Used when a longer text is expected. The field should be rendered as a
    # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
    GENERIC_LONG_TEXT = 2
  end
end

#format_info ⇒ ::String

Returns Information about the required format. If present, it should be shown close to the input field to help the business to provide a correct value. For example: "VAT numbers should be in a format similar to SK9999999999".

Returns:

  • (::String) —

    Information about the required format. If present, it should be shown close to the input field to help the business to provide a correct value. For example: "VAT numbers should be in a format similar to SK9999999999"



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 609

class TextInput
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum specifying the type of the text input and how it should be rendered.
  module TextInputType
    # Default value. Will never be provided by the API.
    TEXT_INPUT_TYPE_UNSPECIFIED = 0

    # Used when a short text is expected. The field can be rendered as a
    # [text
    # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
    GENERIC_SHORT_TEXT = 1

    # Used when a longer text is expected. The field should be rendered as a
    # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
    GENERIC_LONG_TEXT = 2
  end
end

#type ⇒ ::Google::Shopping::Merchant::IssueResolution::V1beta::InputField::TextInput::TextInputType

Returns Type of the text input.

Returns:



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'proto_docs/google/shopping/merchant/issueresolution/v1beta/issueresolution.rb', line 609

class TextInput
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum specifying the type of the text input and how it should be rendered.
  module TextInputType
    # Default value. Will never be provided by the API.
    TEXT_INPUT_TYPE_UNSPECIFIED = 0

    # Used when a short text is expected. The field can be rendered as a
    # [text
    # field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).
    GENERIC_SHORT_TEXT = 1

    # Used when a longer text is expected. The field should be rendered as a
    # [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea).
    GENERIC_LONG_TEXT = 2
  end
end