Class: Google::Apis::ChatV1::GoogleAppsCardV1SelectionInput

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

A widget that creates one or more UI items that users can select. Supports form submission validation for dropdown and multiselect menus only. When Action.all_widgets_are_required is set to true or this widget is specified in Action.required_widgets, the submission action is blocked unless a value is selected. 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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsCardV1SelectionInput

Returns a new instance of GoogleAppsCardV1SelectionInput.



3811
3812
3813
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3811

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

Instance Attribute Details

#data_source_configs ⇒ Array<Google::Apis::ChatV1::GoogleAppsCardV1DataSourceConfig>

Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the multi_select_max_selected_items field, multi_select_min_query_length field, external_data_source field and platform_data_source field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the Dropdown widget in Google Chat apps. For the Dropdown widget in Google Chat apps, only one DataSourceConfig is supported. If multiple DataSourceConfigs are set, only the first one is used. Corresponds to the JSON property dataSourceConfigs

Returns:



3732
3733
3734
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3732

def data_source_configs
  @data_source_configs
end

#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

Returns:



3740
3741
3742
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3740

def external_data_source
  @external_data_source
end

#hint_text ⇒ String

Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. Corresponds to the JSON property hintText

Returns:

  • (String) 


3748
3749
3750
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3748

def hint_text
  @hint_text
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

Returns:



3754
3755
3756
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3754

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

Returns:

  • (String) 


3762
3763
3764
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3762

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

Returns:

  • (Fixnum) 


3768
3769
3770
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3768

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 menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of SelectionInput items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source ( multi_select_data_source), defaults to 3 characters before querying the data source to return suggested items. Corresponds to the JSON property multiSelectMinQueryLength

Returns:

  • (Fixnum) 


3779
3780
3781
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3779

def multi_select_min_query_length
  @multi_select_min_query_length
end

#name ⇒ String

Required. 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

Returns:

  • (String) 


3786
3787
3788
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3786

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:



3794
3795
3796
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3794

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

Returns:



3801
3802
3803
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3801

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

Returns:

  • (String) 


3809
3810
3811
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3809

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3816

def update!(**args)
  @data_source_configs = args[:data_source_configs] if args.key?(:data_source_configs)
  @external_data_source = args[:external_data_source] if args.key?(:external_data_source)
  @hint_text = args[:hint_text] if args.key?(:hint_text)
  @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