Class: Google::Apis::ChatV1::GoogleAppsCardV1TextInput

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/chat_v1/classes.rb,
lib/google/apis/chat_v1/representations.rb,
lib/google/apis/chat_v1/representations.rb

Overview

A field in which users can enter text. Supports suggestions and on-change actions. 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:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1TextInput

Returns a new instance of GoogleAppsCardV1TextInput.



2932
2933
2934
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2932

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#auto_complete_action ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Action

An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property autoCompleteAction

Returns:



2864
2865
2866
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2864

def auto_complete_action
  @auto_complete_action
end

#hint_text ⇒ String

Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible. Required if label is unspecified. Otherwise, optional. Corresponds to the JSON property hintText

Returns:

  • (String) 


2871
2872
2873
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2871

def hint_text
  @hint_text
end

#initial_suggestions ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Suggestions

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed. For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav, the list of suggestions filters to show Java and JavaScript. Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script. Suggesting JavaScript can standardize how users interact with your app. When specified, TextInput.type is always SINGLE_LINE, even if it's set to MULTIPLE_LINE. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property initialSuggestions

Returns:



2886
2887
2888
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2886

def initial_suggestions
  @initial_suggestions
end

#label ⇒ String

The text that appears above the text input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write surname instead of name. Required if hintText is unspecified. Otherwise, optional. Corresponds to the JSON property label

Returns:

  • (String) 


2895
2896
2897
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2895

def label
  @label
end

#name ⇒ String

The name by which the text input is identified in a form input event. For details about working with form inputs, see Receive form data. Corresponds to the JSON property name

Returns:

  • (String) 


2902
2903
2904
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2902

def name
  @name
end

#on_change_action ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Action

An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. Google Workspace Add-ons and Chat apps: Corresponds to the JSON property onChangeAction

Returns:



2910
2911
2912
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2910

def on_change_action
  @on_change_action
end

#placeholder_text ⇒ String

Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, Enter a number from 0 to 100. Google Chat apps: Corresponds to the JSON property placeholderText

Returns:

  • (String) 


2917
2918
2919
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2917

def placeholder_text
  @placeholder_text
end

#type ⇒ String

How a text input field appears in the user interface. For example, whether the field is single or multi-line. Corresponds to the JSON property type

Returns:

  • (String) 


2923
2924
2925
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2923

def type
  @type
end

#value ⇒ String

The value entered by a user, returned as part of a form input event. For details about working with form inputs, see Receive form data. Corresponds to the JSON property value

Returns:

  • (String) 


2930
2931
2932
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2930

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2937

def update!(**args)
  @auto_complete_action = args[:auto_complete_action] if args.key?(:auto_complete_action)
  @hint_text = args[:hint_text] if args.key?(:hint_text)
  @initial_suggestions = args[:initial_suggestions] if args.key?(:initial_suggestions)
  @label = args[:label] if args.key?(:label)
  @name = args[:name] if args.key?(:name)
  @on_change_action = args[:on_change_action] if args.key?(:on_change_action)
  @placeholder_text = args[:placeholder_text] if args.key?(:placeholder_text)
  @type = args[:type] if args.key?(:type)
  @value = args[:value] if args.key?(:value)
end