Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Card::V1::DecoratedText::SwitchControl.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#control_type
def control_type() -> ::Google::Apps::Card::V1::DecoratedText::SwitchControl::ControlType
Returns
-
(::Google::Apps::Card::V1::DecoratedText::SwitchControl::ControlType) — How the switch appears in the user interface.
#control_type=
def control_type=(value) -> ::Google::Apps::Card::V1::DecoratedText::SwitchControl::ControlType
Parameter
-
value (::Google::Apps::Card::V1::DecoratedText::SwitchControl::ControlType) — How the switch appears in the user interface.
Returns
-
(::Google::Apps::Card::V1::DecoratedText::SwitchControl::ControlType) — How the switch appears in the user interface.
#name
def name() -> ::String
Returns
-
(::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.
#name=
def name=(value) -> ::String
Parameter
-
value (::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.
Returns
-
(::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.
#on_change_action
def on_change_action() -> ::Google::Apps::Card::V1::Action
Returns
- (::Google::Apps::Card::V1::Action) — The action to perform when the switch state is changed, such as what function to run.
#on_change_action=
def on_change_action=(value) -> ::Google::Apps::Card::V1::Action
Parameter
- value (::Google::Apps::Card::V1::Action) — The action to perform when the switch state is changed, such as what function to run.
Returns
- (::Google::Apps::Card::V1::Action) — The action to perform when the switch state is changed, such as what function to run.
#selected
def selected() -> ::Boolean
Returns
-
(::Boolean) — When
true, the switch is selected.
#selected=
def selected=(value) -> ::Boolean
Parameter
-
value (::Boolean) — When
true, the switch is selected.
Returns
-
(::Boolean) — When
true, the switch is selected.
#value
def value() -> ::String
Returns
-
(::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.
#value=
def value=(value) -> ::String
Parameter
-
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.
Returns
-
(::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.