Class GoogleAppsCardV1SelectionInput
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:
Implements
Inherited Members
Namespace: Google.Apis.HangoutsChat.v1.Data
Assembly: Google.Apis.HangoutsChat.v1.dll
Syntax
public class GoogleAppsCardV1SelectionInput : IDirectResponseSchema
Properties
DataSourceConfigs
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 flows, which is available as
part of the Gemini Alpha program. Unavailable for Google
Chat apps.
Declaration
[JsonProperty("dataSourceConfigs")]
public virtual IList<GoogleAppsCardV1DataSourceConfig> DataSourceConfigs { get; set; }
Property Value
| Type | Description |
|---|---|
| IList<GoogleAppsCardV1DataSourceConfig> |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ExternalDataSource
An external data source, such as a relational database.
Declaration
[JsonProperty("externalDataSource")]
public virtual GoogleAppsCardV1Action ExternalDataSource { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleAppsCardV1Action |
HintText
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 flows, which is available as part of the Gemini Alpha program. Unavailable for Google Chat apps.
Declaration
[JsonProperty("hintText")]
public virtual string HintText { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Items
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
Declaration
[JsonProperty("items")]
public virtual IList<GoogleAppsCardV1SelectionItem> Items { get; set; }
Property Value
| Type | Description |
|---|---|
| IList<GoogleAppsCardV1SelectionItem> |
Label
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".
Declaration
[JsonProperty("label")]
public virtual string Label { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
MultiSelectMaxSelectedItems
For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
Declaration
[JsonProperty("multiSelectMaxSelectedItems")]
public virtual int? MultiSelectMaxSelectedItems { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
MultiSelectMinQueryLength
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.
Declaration
[JsonProperty("multiSelectMinQueryLength")]
public virtual int? MultiSelectMinQueryLength { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
Name
Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see Receive form data.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
OnChangeAction
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.
Declaration
[JsonProperty("onChangeAction")]
public virtual GoogleAppsCardV1Action OnChangeAction { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleAppsCardV1Action |
PlatformDataSource
A data source from Google Workspace.
Declaration
[JsonProperty("platformDataSource")]
public virtual GoogleAppsCardV1PlatformDataSource PlatformDataSource { get; set; }
Property Value
| Type | Description |
|---|---|
| GoogleAppsCardV1PlatformDataSource |
Type
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.
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
| Type | Description |
|---|---|
| string |