Class: Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput
- Inherits:
-
Object
- Object
- Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput
- 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
A widget that creates one or more UI items that users can select. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see Add selectable UI elements. Chat apps can process the value of items that users select or input. For details about working with form inputs, see Receive form data . To collect undefined or abstract data from users, use the TextInput widget. Google Workspace Add-ons and Chat apps:
Instance Attribute Summary collapse
-
#external_data_source ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Action
An action that describes the behavior when the form is submitted.
-
#items ⇒ Array<Google::Apis::ChatV1::GoogleAppsCardV1SelectionItem>
An array of selectable items.
-
#label ⇒ String
The text that appears above the selection input field in the user interface.
-
#multi_select_max_selected_items ⇒ Fixnum
For multiselect menus, the maximum number of items that a user can select.
-
#multi_select_min_query_length ⇒ Fixnum
For multiselect menus, the number of text characters that a user inputs before the app queries autocomplete and displays suggested items in the menu.
-
#name ⇒ String
The name that identifies the selection input in a form input event.
-
#on_change_action ⇒ Google::Apis::ChatV1::GoogleAppsCardV1Action
An action that describes the behavior when the form is submitted.
-
#platform_data_source ⇒ Google::Apis::ChatV1::GoogleAppsCardV1PlatformDataSource
For a
SelectionInput
widget that uses a multiselect menu, a data source from Google Workspace. -
#type ⇒ String
The type of items that are displayed to users in a
SelectionInput
widget.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleAppsCardV1SelectionInput
constructor
A new instance of GoogleAppsCardV1SelectionInput.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleAppsCardV1SelectionInput
Returns a new instance of GoogleAppsCardV1SelectionInput.
2634 2635 2636 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2634 def initialize(**args) update!(**args) end |
Instance Attribute Details
#external_data_source ⇒ 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 externalDataSource
2574 2575 2576 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2574 def external_data_source @external_data_source end |
#items ⇒ Array<Google::Apis::ChatV1::GoogleAppsCardV1SelectionItem>
An array of selectable items. For example, an array of radio buttons or
checkboxes. Supports up to 100 items.
Corresponds to the JSON property items
2580 2581 2582 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2580 def items @items end |
#label ⇒ String
The text that appears above the selection input field in the user interface.
Specify text that helps the user enter the information your app needs. For
example, if users are selecting the urgency of a work ticket from a drop-down
menu, the label might be "Urgency" or "Select urgency".
Corresponds to the JSON property label
2588 2589 2590 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2588 def label @label end |
#multi_select_max_selected_items ⇒ Fixnum
For multiselect menus, the maximum number of items that a user can select.
Minimum value is 1 item. If unspecified, defaults to 3 items.
Corresponds to the JSON property multiSelectMaxSelectedItems
2594 2595 2596 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2594 def multi_select_max_selected_items @multi_select_max_selected_items end |
#multi_select_min_query_length ⇒ Fixnum
For multiselect menus, the number of text characters that a user inputs before
the app queries autocomplete and displays suggested items in the menu. If
unspecified, defaults to 0 characters for static data sources and 3 characters
for external data sources.
Corresponds to the JSON property multiSelectMinQueryLength
2602 2603 2604 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2602 def multi_select_min_query_length @multi_select_min_query_length end |
#name ⇒ String
The name that identifies the selection input in a form input event. For
details about working with form inputs, see Receive form data.
Corresponds to the JSON property name
2609 2610 2611 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2609 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
2617 2618 2619 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2617 def on_change_action @on_change_action end |
#platform_data_source ⇒ Google::Apis::ChatV1::GoogleAppsCardV1PlatformDataSource
For a SelectionInput
widget that uses a multiselect menu, a data source from
Google Workspace. Used to populate items in a multiselect menu. Google Chat
apps:
Corresponds to the JSON property platformDataSource
2624 2625 2626 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2624 def platform_data_source @platform_data_source end |
#type ⇒ String
The type of items that are displayed to users in a SelectionInput
widget.
Selection types support different types of interactions. For example, users
can select one or more checkboxes, but they can only select one value from a
dropdown menu.
Corresponds to the JSON property type
2632 2633 2634 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2632 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 |
# File 'lib/google/apis/chat_v1/classes.rb', line 2639 def update!(**args) @external_data_source = args[:external_data_source] if args.key?(:external_data_source) @items = args[:items] if args.key?(:items) @label = args[:label] if args.key?(:label) @multi_select_max_selected_items = args[:multi_select_max_selected_items] if args.key?(:multi_select_max_selected_items) @multi_select_min_query_length = args[:multi_select_min_query_length] if args.key?(:multi_select_min_query_length) @name = args[:name] if args.key?(:name) @on_change_action = args[:on_change_action] if args.key?(:on_change_action) @platform_data_source = args[:platform_data_source] if args.key?(:platform_data_source) @type = args[:type] if args.key?(:type) end |