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.



3716
3717
3718
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3716

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) 


3686
3687
3688
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3686

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) 


3693
3694
3695
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3693

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:



3701
3702
3703
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3701

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) 


3706
3707
3708
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3706

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) 


3714
3715
3716
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3714

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3721
3722
3723
3724
3725
3726
3727
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3721

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