Package com.google.apps.card.v1
Interface SelectionInputOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
SelectionInput
,SelectionInput.Builder
public interface SelectionInputOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Action
getExternalDataSource()
An external data source, such as a relational data base.ActionOrBuilder
getExternalDataSourceOrBuilder()
An external data source, such as a relational data base.SelectionInput.SelectionItem
getItems(int index)
An array of selectable items.int
getItemsCount()
An array of selectable items.java.util.List<SelectionInput.SelectionItem>
getItemsList()
An array of selectable items.SelectionInput.SelectionItemOrBuilder
getItemsOrBuilder(int index)
An array of selectable items.java.util.List<? extends SelectionInput.SelectionItemOrBuilder>
getItemsOrBuilderList()
An array of selectable items.java.lang.String
getLabel()
The text that appears above the selection input field in the user interface.com.google.protobuf.ByteString
getLabelBytes()
The text that appears above the selection input field in the user interface.SelectionInput.MultiSelectDataSourceCase
getMultiSelectDataSourceCase()
int
getMultiSelectMaxSelectedItems()
For multiselect menus, the maximum number of items that a user can select.int
getMultiSelectMinQueryLength()
For multiselect menus, the number of text characters that a user inputs before the app queries autocomplete and displays suggested items in the menu.java.lang.String
getName()
The name that identifies the selection input in a form input event.com.google.protobuf.ByteString
getNameBytes()
The name that identifies the selection input in a form input event.Action
getOnChangeAction()
If specified, the form is submitted when the selection changes.ActionOrBuilder
getOnChangeActionOrBuilder()
If specified, the form is submitted when the selection changes.SelectionInput.PlatformDataSource
getPlatformDataSource()
A data source from Google Workspace.SelectionInput.PlatformDataSourceOrBuilder
getPlatformDataSourceOrBuilder()
A data source from Google Workspace.SelectionInput.SelectionType
getType()
The type of items that are displayed to users in a `SelectionInput` widget.int
getTypeValue()
The type of items that are displayed to users in a `SelectionInput` widget.boolean
hasExternalDataSource()
An external data source, such as a relational data base.boolean
hasOnChangeAction()
If specified, the form is submitted when the selection changes.boolean
hasPlatformDataSource()
A data source from Google Workspace.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
java.lang.String getName()
The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
string name = 1;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()
The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
string name = 1;
- Returns:
- The bytes for name.
-
getLabel
java.lang.String 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 label = 2;
- Returns:
- The label.
-
getLabelBytes
com.google.protobuf.ByteString getLabelBytes()
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 label = 2;
- Returns:
- The bytes for label.
-
getTypeValue
int getTypeValue()
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.
.google.apps.card.v1.SelectionInput.SelectionType type = 3;
- Returns:
- The enum numeric value on the wire for type.
-
getType
SelectionInput.SelectionType 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.
.google.apps.card.v1.SelectionInput.SelectionType type = 3;
- Returns:
- The type.
-
getItemsList
java.util.List<SelectionInput.SelectionItem> getItemsList()
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
repeated .google.apps.card.v1.SelectionInput.SelectionItem items = 4;
-
getItems
SelectionInput.SelectionItem getItems(int index)
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
repeated .google.apps.card.v1.SelectionInput.SelectionItem items = 4;
-
getItemsCount
int getItemsCount()
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
repeated .google.apps.card.v1.SelectionInput.SelectionItem items = 4;
-
getItemsOrBuilderList
java.util.List<? extends SelectionInput.SelectionItemOrBuilder> getItemsOrBuilderList()
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
repeated .google.apps.card.v1.SelectionInput.SelectionItem items = 4;
-
getItemsOrBuilder
SelectionInput.SelectionItemOrBuilder getItemsOrBuilder(int index)
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
repeated .google.apps.card.v1.SelectionInput.SelectionItem items = 4;
-
hasOnChangeAction
boolean hasOnChangeAction()
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](https://developers.google.com/workspace/chat/read-form-data).
.google.apps.card.v1.Action on_change_action = 5;
- Returns:
- Whether the onChangeAction field is set.
-
getOnChangeAction
Action 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](https://developers.google.com/workspace/chat/read-form-data).
.google.apps.card.v1.Action on_change_action = 5;
- Returns:
- The onChangeAction.
-
getOnChangeActionOrBuilder
ActionOrBuilder getOnChangeActionOrBuilder()
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](https://developers.google.com/workspace/chat/read-form-data).
.google.apps.card.v1.Action on_change_action = 5;
-
getMultiSelectMaxSelectedItems
int 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.
int32 multi_select_max_selected_items = 6;
- Returns:
- The multiSelectMaxSelectedItems.
-
getMultiSelectMinQueryLength
int getMultiSelectMinQueryLength()
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.
int32 multi_select_min_query_length = 7;
- Returns:
- The multiSelectMinQueryLength.
-
hasExternalDataSource
boolean hasExternalDataSource()
An external data source, such as a relational data base.
.google.apps.card.v1.Action external_data_source = 8;
- Returns:
- Whether the externalDataSource field is set.
-
getExternalDataSource
Action getExternalDataSource()
An external data source, such as a relational data base.
.google.apps.card.v1.Action external_data_source = 8;
- Returns:
- The externalDataSource.
-
getExternalDataSourceOrBuilder
ActionOrBuilder getExternalDataSourceOrBuilder()
An external data source, such as a relational data base.
.google.apps.card.v1.Action external_data_source = 8;
-
hasPlatformDataSource
boolean hasPlatformDataSource()
A data source from Google Workspace.
.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
- Returns:
- Whether the platformDataSource field is set.
-
getPlatformDataSource
SelectionInput.PlatformDataSource getPlatformDataSource()
A data source from Google Workspace.
.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
- Returns:
- The platformDataSource.
-
getPlatformDataSourceOrBuilder
SelectionInput.PlatformDataSourceOrBuilder getPlatformDataSourceOrBuilder()
A data source from Google Workspace.
.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
-
getMultiSelectDataSourceCase
SelectionInput.MultiSelectDataSourceCase getMultiSelectDataSourceCase()
-
-