Google Chat V1 API - Class Google::Apps::Card::V1::SelectionInput::SelectionItem (v0.5.1)

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Card::V1::SelectionInput::SelectionItem.

An item that users can select in a selection input, such as a checkbox or switch.

Google Workspace Add-ons and Chat apps:

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bottom_text

def bottom_text() -> ::String
Returns
  • (::String) — For multiselect menus, a text description or label that's displayed below the item's text field.

#bottom_text=

def bottom_text=(value) -> ::String
Parameter
  • value (::String) — For multiselect menus, a text description or label that's displayed below the item's text field.
Returns
  • (::String) — For multiselect menus, a text description or label that's displayed below the item's text field.

#selected

def selected() -> ::Boolean
Returns
  • (::Boolean) — Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.

#selected=

def selected=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.
Returns
  • (::Boolean) — Whether the item is selected by default. If the selection input only accepts one value (such as for radio buttons or a dropdown menu), only set this field for one item.

#start_icon_uri

def start_icon_uri() -> ::String
Returns
  • (::String) — For multiselect menus, the URL for the icon displayed next to the item's text field. Supports PNG and JPEG files. Must be an HTTPS URL. For example, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.

#start_icon_uri=

def start_icon_uri=(value) -> ::String
Parameter
  • value (::String) — For multiselect menus, the URL for the icon displayed next to the item's text field. Supports PNG and JPEG files. Must be an HTTPS URL. For example, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
Returns
  • (::String) — For multiselect menus, the URL for the icon displayed next to the item's text field. Supports PNG and JPEG files. Must be an HTTPS URL. For example, https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.

#text

def text() -> ::String
Returns
  • (::String) — The text that identifies or describes the item to users.

#text=

def text=(value) -> ::String
Parameter
  • value (::String) — The text that identifies or describes the item to users.
Returns
  • (::String) — The text that identifies or describes the item to users.

#value

def value() -> ::String
Returns
  • (::String) — The value associated with this item. The client should use this as a form input value.

    For details about working with form inputs, see Receive form data.

#value=

def value=(value) -> ::String
Parameter
  • value (::String) — The value associated with this item. The client should use this as a form input value.

    For details about working with form inputs, see Receive form data.

Returns
  • (::String) — The value associated with this item. The client should use this as a form input value.

    For details about working with form inputs, see Receive form data.