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. Google Workspace Add-ons and Chat apps: Only supported in the decoratedText widget.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1SwitchControl

Returns a new instance of GoogleAppsCardV1SwitchControl.



2617
2618
2619
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2617

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

Returns:

  • (String) 


2587
2588
2589
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2587

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) 


2594
2595
2596
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2594

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:



2602
2603
2604
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2602

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) 


2607
2608
2609
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2607

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) 


2615
2616
2617
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2615

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2622
2623
2624
2625
2626
2627
2628
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2622

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