Class: Google::Apis::ChatV1::GoogleAppsCardV1SelectionItem

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

An item that users can select in a selection input, such as a checkbox or switch. Google Workspace Add-ons and Chat apps:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1SelectionItem

Returns a new instance of GoogleAppsCardV1SelectionItem.



2730
2731
2732
# File 'lib/google/apis/chat_v1/classes.rb', line 2730

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bottom_textString

For multiselect menus, a text description or label that's displayed below the item's text field. Corresponds to the JSON property bottomText

Returns:

  • (String)


2701
2702
2703
# File 'lib/google/apis/chat_v1/classes.rb', line 2701

def bottom_text
  @bottom_text
end

#selectedBoolean Also known as: selected?

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. Corresponds to the JSON property selected

Returns:

  • (Boolean)


2708
2709
2710
# File 'lib/google/apis/chat_v1/classes.rb', line 2708

def selected
  @selected
end

#start_icon_uriString

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. Corresponds to the JSON property startIconUri

Returns:

  • (String)


2716
2717
2718
# File 'lib/google/apis/chat_v1/classes.rb', line 2716

def start_icon_uri
  @start_icon_uri
end

#textString

The text that identifies or describes the item to users. Corresponds to the JSON property text

Returns:

  • (String)


2721
2722
2723
# File 'lib/google/apis/chat_v1/classes.rb', line 2721

def text
  @text
end

#valueString

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. Corresponds to the JSON property value

Returns:

  • (String)


2728
2729
2730
# File 'lib/google/apis/chat_v1/classes.rb', line 2728

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2735
2736
2737
2738
2739
2740
2741
# File 'lib/google/apis/chat_v1/classes.rb', line 2735

def update!(**args)
  @bottom_text = args[:bottom_text] if args.key?(:bottom_text)
  @selected = args[:selected] if args.key?(:selected)
  @start_icon_uri = args[:start_icon_uri] if args.key?(:start_icon_uri)
  @text = args[:text] if args.key?(:text)
  @value = args[:value] if args.key?(:value)
end