Class: Google::Apis::ChatV1::GoogleAppsCardV1SwitchControl
- Inherits:
-
Object
- Object
- Google::Apis::ChatV1::GoogleAppsCardV1SwitchControl
- 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.
Google Workspace Add-ons and Chat apps: Only supported in the decoratedText
widget.
Instance Attribute Summary collapse
-
#control_type ⇒ String
How the switch appears in the user interface.
-
#name ⇒ String
The name by which the switch widget is identified in a form input event.
-
#on_change_action ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Action
An action that describes the behavior when the form is submitted.
-
#selected ⇒ Boolean
(also: #selected?)
When
true
, the switch is selected. -
#value ⇒ String
The value entered by a user, returned as part of a form input event.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleAppsCardV1SwitchControl
constructor
A new instance of GoogleAppsCardV1SwitchControl.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleAppsCardV1SwitchControl
Returns a new instance of GoogleAppsCardV1SwitchControl.
2797 2798 2799 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2797 def initialize(**args) update!(**args) end |
Instance Attribute Details
#control_type ⇒ String
How the switch appears in the user interface. Google Workspace Add-ons and
Chat apps:
Corresponds to the JSON property controlType
2767 2768 2769 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2767 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
2774 2775 2776 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2774 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
2782 2783 2784 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2782 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
2787 2788 2789 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2787 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
2795 2796 2797 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2795 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2802 2803 2804 2805 2806 2807 2808 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2802 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 |