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 text input is a UI item where users can input text. A text input can also have an onChange action and suggestions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1TextInput

Returns a new instance of GoogleAppsCardV1TextInput.



1837
1838
1839
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1837

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:



1798
1799
1800
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1798

def auto_complete_action
  @auto_complete_action
end

#hint_text ⇒ String

The hint text. Corresponds to the JSON property hintText

Returns:

  • (String) 


1803
1804
1805
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1803

def hint_text
  @hint_text
end

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

A container wrapping elements necessary for showing suggestion items used in text input autocomplete. Corresponds to the JSON property initialSuggestions

Returns:



1809
1810
1811
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1809

def initial_suggestions
  @initial_suggestions
end

#label ⇒ String

At least one of label and hintText must be specified. Corresponds to the JSON property label

Returns:

  • (String) 


1814
1815
1816
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1814

def label
  @label
end

#name ⇒ String

The name of the text input which is used in formInput. Corresponds to the JSON property name

Returns:

  • (String) 


1819
1820
1821
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1819

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:



1825
1826
1827
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1825

def on_change_action
  @on_change_action
end

#type ⇒ String

The style of the text, for example, a single line or multiple lines. Corresponds to the JSON property type

Returns:

  • (String) 


1830
1831
1832
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1830

def type
  @type
end

#value ⇒ String

The default value when there is no input from the user. Corresponds to the JSON property value

Returns:

  • (String) 


1835
1836
1837
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1835

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
 
# File 'lib/google/apis/chat_v1/classes.rb', line 1842

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