Package com.google.apps.card.v1
Class SelectionInput
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.apps.card.v1.SelectionInput
- All Implemented Interfaces:
SelectionInputOrBuilder
,com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class SelectionInput
extends com.google.protobuf.GeneratedMessageV3
implements SelectionInputOrBuilder
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](/workspace/chat/design-interactive-card-dialog#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](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the [TextInput][google.apps.card.v1.TextInput] widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):Protobuf type
google.apps.card.v1.SelectionInput
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A widget that creates one or more UI items that users can select.static enum
static final class
For a [`SelectionInput`][google.apps.card.v1.SelectionInput] widget that uses a multiselect menu, a data source from Google Workspace.static interface
static final class
An item that users can select in a selection input, such as a checkbox or switch.static interface
static enum
The format for the items that users can select.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,
T> Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static SelectionInput
static final com.google.protobuf.Descriptors.Descriptor
An external data source, such as a relational data base.An external data source, such as a relational data base.getItems
(int index) An array of selectable items.int
An array of selectable items.An array of selectable items.getItemsOrBuilder
(int index) An array of selectable items.List
<? extends SelectionInput.SelectionItemOrBuilder> An array of selectable items.getLabel()
The text that appears above the selection input field in the user interface.com.google.protobuf.ByteString
The text that appears above the selection input field in the user interface.int
For multiselect menus, the maximum number of items that a user can select.int
For multiselect menus, the number of text characters that a user inputs before the app queries autocomplete and displays suggested items in the menu.getName()
The name that identifies the selection input in a form input event.com.google.protobuf.ByteString
The name that identifies the selection input in a form input event.If specified, the form is submitted when the selection changes.If specified, the form is submitted when the selection changes.com.google.protobuf.Parser
<SelectionInput> A data source from Google Workspace.A data source from Google Workspace.int
getType()
The type of items that are displayed to users in a `SelectionInput` widget.int
The type of items that are displayed to users in a `SelectionInput` widget.boolean
An external data source, such as a relational data base.int
hashCode()
boolean
If specified, the form is submitted when the selection changes.boolean
A data source from Google Workspace.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
static SelectionInput.Builder
static SelectionInput.Builder
newBuilder
(SelectionInput prototype) protected SelectionInput.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static SelectionInput
parseDelimitedFrom
(InputStream input) static SelectionInput
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SelectionInput
parseFrom
(byte[] data) static SelectionInput
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SelectionInput
parseFrom
(com.google.protobuf.ByteString data) static SelectionInput
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SelectionInput
parseFrom
(com.google.protobuf.CodedInputStream input) static SelectionInput
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SelectionInput
parseFrom
(InputStream input) static SelectionInput
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SelectionInput
parseFrom
(ByteBuffer data) static SelectionInput
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<SelectionInput> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage
extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
LABEL_FIELD_NUMBER
public static final int LABEL_FIELD_NUMBER- See Also:
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER- See Also:
-
ITEMS_FIELD_NUMBER
public static final int ITEMS_FIELD_NUMBER- See Also:
-
ON_CHANGE_ACTION_FIELD_NUMBER
public static final int ON_CHANGE_ACTION_FIELD_NUMBER- See Also:
-
MULTI_SELECT_MAX_SELECTED_ITEMS_FIELD_NUMBER
public static final int MULTI_SELECT_MAX_SELECTED_ITEMS_FIELD_NUMBER- See Also:
-
MULTI_SELECT_MIN_QUERY_LENGTH_FIELD_NUMBER
public static final int MULTI_SELECT_MIN_QUERY_LENGTH_FIELD_NUMBER- See Also:
-
EXTERNAL_DATA_SOURCE_FIELD_NUMBER
public static final int EXTERNAL_DATA_SOURCE_FIELD_NUMBER- See Also:
-
PLATFORM_DATA_SOURCE_FIELD_NUMBER
public static final int PLATFORM_DATA_SOURCE_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getMultiSelectDataSourceCase
- Specified by:
getMultiSelectDataSourceCase
in interfaceSelectionInputOrBuilder
-
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;
- Specified by:
getName
in interfaceSelectionInputOrBuilder
- Returns:
- The name.
-
getNameBytes
public 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;
- Specified by:
getNameBytes
in interfaceSelectionInputOrBuilder
- Returns:
- The bytes for name.
-
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;
- Specified by:
getLabel
in interfaceSelectionInputOrBuilder
- Returns:
- The label.
-
getLabelBytes
public 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;
- Specified by:
getLabelBytes
in interfaceSelectionInputOrBuilder
- Returns:
- The bytes for label.
-
getTypeValue
public 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;
- Specified by:
getTypeValue
in interfaceSelectionInputOrBuilder
- Returns:
- The enum numeric value on the wire for type.
-
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;
- Specified by:
getType
in interfaceSelectionInputOrBuilder
- Returns:
- The type.
-
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;
- Specified by:
getItemsList
in interfaceSelectionInputOrBuilder
-
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;
- Specified by:
getItemsOrBuilderList
in interfaceSelectionInputOrBuilder
-
getItemsCount
public 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;
- Specified by:
getItemsCount
in interfaceSelectionInputOrBuilder
-
getItems
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;
- Specified by:
getItems
in interfaceSelectionInputOrBuilder
-
getItemsOrBuilder
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;
- Specified by:
getItemsOrBuilder
in interfaceSelectionInputOrBuilder
-
hasOnChangeAction
public 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;
- Specified by:
hasOnChangeAction
in interfaceSelectionInputOrBuilder
- Returns:
- Whether the onChangeAction field is set.
-
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;
- Specified by:
getOnChangeAction
in interfaceSelectionInputOrBuilder
- Returns:
- The onChangeAction.
-
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;
- Specified by:
getOnChangeActionOrBuilder
in interfaceSelectionInputOrBuilder
-
getMultiSelectMaxSelectedItems
public 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;
- Specified by:
getMultiSelectMaxSelectedItems
in interfaceSelectionInputOrBuilder
- Returns:
- The multiSelectMaxSelectedItems.
-
getMultiSelectMinQueryLength
public 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;
- Specified by:
getMultiSelectMinQueryLength
in interfaceSelectionInputOrBuilder
- Returns:
- The multiSelectMinQueryLength.
-
hasExternalDataSource
public boolean hasExternalDataSource()An external data source, such as a relational data base.
.google.apps.card.v1.Action external_data_source = 8;
- Specified by:
hasExternalDataSource
in interfaceSelectionInputOrBuilder
- Returns:
- Whether the externalDataSource field is set.
-
getExternalDataSource
An external data source, such as a relational data base.
.google.apps.card.v1.Action external_data_source = 8;
- Specified by:
getExternalDataSource
in interfaceSelectionInputOrBuilder
- Returns:
- The externalDataSource.
-
getExternalDataSourceOrBuilder
An external data source, such as a relational data base.
.google.apps.card.v1.Action external_data_source = 8;
- Specified by:
getExternalDataSourceOrBuilder
in interfaceSelectionInputOrBuilder
-
hasPlatformDataSource
public boolean hasPlatformDataSource()A data source from Google Workspace.
.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
- Specified by:
hasPlatformDataSource
in interfaceSelectionInputOrBuilder
- Returns:
- Whether the platformDataSource field is set.
-
getPlatformDataSource
A data source from Google Workspace.
.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
- Specified by:
getPlatformDataSource
in interfaceSelectionInputOrBuilder
- Returns:
- The platformDataSource.
-
getPlatformDataSourceOrBuilder
A data source from Google Workspace.
.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
- Specified by:
getPlatformDataSourceOrBuilder
in interfaceSelectionInputOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static SelectionInput parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SelectionInput parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SelectionInput parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SelectionInput parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SelectionInput parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SelectionInput parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static SelectionInput parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static SelectionInput parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static SelectionInput parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static SelectionInput parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected SelectionInput.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-