Class: Google::Apps::Card::V1::TextInput

Inherits:

Object

• Object
• Google::Apps::Card::V1::TextInput

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/apps/card/v1/card.rb

Overview

A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When Action.all_widgets_are_required is set to true or this widget is specified in Action.required_widgets, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see Add a field in which a user can enter text.

Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see Receive form data.

When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget.

Google Workspace add-ons and Chat apps:

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #auto_complete_action ⇒ ::Google::Apps::Card::V1::Action

  Optional.

• #hint_text ⇒ ::String

  Text that appears below the text input field meant to assist users by prompting them to enter a certain value.

• #initial_suggestions ⇒ ::Google::Apps::Card::V1::Suggestions

  Suggested values that users can enter.

• #label ⇒ ::String

  The text that appears above the text input field in the user interface.

• #name ⇒ ::String

  The name by which the text input is identified in a form input event.

• #on_change_action ⇒ ::Google::Apps::Card::V1::Action

  What to do when a change occurs in the text input field.

• #placeholder_text ⇒ ::String

  Text that appears in the text input field when the field is empty.

• #type ⇒ ::Google::Apps::Card::V1::TextInput::Type

  How a text input field appears in the user interface.

• #validation ⇒ ::Google::Apps::Card::V1::Validation

  Specify the input format validation necessary for this text field.

• #value ⇒ ::String

  The value entered by a user, returned as part of a form input event.

Instance Attribute Details

#auto_complete_action ⇒ ::Google::Apps::Card::V1::Action

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end

#hint_text ⇒ ::String

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end

#initial_suggestions ⇒ ::Google::Apps::Card::V1::Suggestions

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end

#label ⇒ ::String

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end

#name ⇒ ::String

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end

#on_change_action ⇒ ::Google::Apps::Card::V1::Action

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end

#placeholder_text ⇒ ::String

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end

#type ⇒ ::Google::Apps::Card::V1::TextInput::Type

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end

#validation ⇒ ::Google::Apps::Card::V1::Validation

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end

#value ⇒ ::String

# File 'proto_docs/google/apps/card/v1/card.rb', line 1154

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

  # How a text input field appears in the user interface. For example,
  # whether it's a single line input field, or a multi-line input. If
  # `initialSuggestions` is specified, `type` is always `SINGLE_LINE`,
  # even if it's set to `MULTIPLE_LINE`.
  #
  # [Google Workspace add-ons and Chat
  # apps](https://developers.google.com/workspace/extend):
  module Type
    # The text input field has a fixed height of one line.
    SINGLE_LINE = 0

    # The text input field has a fixed height of multiple lines.
    MULTIPLE_LINE = 1
  end
end