Class: Google::Apis::ChatV1::GoogleAppsCardV1SwitchControl

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

Either a toggle-style switch or a checkbox inside a decoratedText widget. Only supported on the decoratedText widget. Currently supported in dialogs. Support for card messages is coming soon.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1SwitchControl

Returns a new instance of GoogleAppsCardV1SwitchControl.



2173
2174
2175
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2173

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

Instance Attribute Details

#control_type ⇒ String

How the switch appears in the user interface. Corresponds to the JSON property controlType

Returns:

  • (String) 


2145
2146
2147
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2145

def control_type
  @control_type
end

#name ⇒ String

The name by which the switch widget 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) 


2152
2153
2154
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2152

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:



2158
2159
2160
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2158

def on_change_action
  @on_change_action
end

#selected ⇒ Boolean Also known as: selected?

When true, the switch is selected. Corresponds to the JSON property selected

Returns:

  • (Boolean) 


2163
2164
2165
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2163

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


2171
2172
2173
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2171

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2178

def update!(**args)
  @control_type = args[:control_type] if args.key?(:control_type)
  @name = args[:name] if args.key?(:name)
  @on_change_action = args[:on_change_action] if args.key?(:on_change_action)
  @selected = args[:selected] if args.key?(:selected)
  @value = args[:value] if args.key?(:value)
end