Reference documentation and code samples for the Google Apps Chat V1 Client class SelectionInput.
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
:
Generated from protobuf message google.apps.card.v1.SelectionInput
Namespace
Google \ Apps \ Card \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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 .
↳ 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".
↳ type
int
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.
↳ items
array< SelectionInput\SelectionItem
>
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
↳ on_change_action
Action
If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see Receive form data .
↳ multi_select_max_selected_items
int
For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
↳ multi_select_min_query_length
int
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.
↳ external_data_source
↳ platform_data_source
getName
Required. The name that identifies the selection input in a form input event.
For details about working with form inputs, see Receive form data .
string
setName
Required. The name that identifies the selection input in a form input event.
For details about working with form inputs, see Receive form data .
var
string
$this
getLabel
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".
string
setLabel
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".
var
string
$this
getType
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.
setType
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.
$this
getItems
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
setItems
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
$this
getOnChangeAction
If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form.
For details about working with form inputs, see Receive form data .
hasOnChangeAction
clearOnChangeAction
setOnChangeAction
If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form.
For details about working with form inputs, see Receive form data .
$this
getMultiSelectMaxSelectedItems
For multiselect menus, the maximum number of items that a user can select.
Minimum value is 1 item. If unspecified, defaults to 3 items.
int
hasMultiSelectMaxSelectedItems
clearMultiSelectMaxSelectedItems
setMultiSelectMaxSelectedItems
For multiselect menus, the maximum number of items that a user can select.
Minimum value is 1 item. If unspecified, defaults to 3 items.
var
int
$this
getMultiSelectMinQueryLength
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
SelectionInputitems, 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.
int
setMultiSelectMinQueryLength
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
SelectionInputitems, 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.
var
int
$this
getExternalDataSource
An external data source, such as a relational database.
hasExternalDataSource
setExternalDataSource
An external data source, such as a relational database.
$this
getPlatformDataSource
A data source from Google Workspace.
hasPlatformDataSource
setPlatformDataSource
A data source from Google Workspace.
$this
getMultiSelectDataSource
string
