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. 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 abstract data from users, use a text input. To collect defined data from users, use the selection input widget instead. Only supported in dialogs. Support for card messages coming soon.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1TextInput

Returns a new instance of GoogleAppsCardV1TextInput.



2260
2261
2262
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2260

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, an Apps Script can be invoked to handle the form. Corresponds to the JSON property autoCompleteAction

Returns:



2202
2203
2204
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2202

def auto_complete_action
  @auto_complete_action
end

#hint_text ⇒ String

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

Returns:

  • (String) 


2209
2210
2211
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2209

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 just 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 is set to MULTIPLE_LINE. Corresponds to the JSON property initialSuggestions

Returns:



2223
2224
2225
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2223

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) 


2232
2233
2234
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2232

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) 


2239
2240
2241
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2239

def name
  @name
end

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

An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. Corresponds to the JSON property onChangeAction

Returns:



2245
2246
2247
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2245

def on_change_action
  @on_change_action
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) 


2251
2252
2253
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2251

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) 


2258
2259
2260
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2258

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2265

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)
  @type = args[:type] if args.key?(:type)
  @value = args[:value] if args.key?(:value)
end