final class SelectionInput extends GeneratedMessageV3 with 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
- Source
- SelectionInput.java
- Alphabetic
- By Inheritance
- SelectionInput
- SelectionInputOrBuilder
- GeneratedMessageV3
- Serializable
- AbstractMessage
- Message
- MessageOrBuilder
- AbstractMessageLite
- MessageLite
- MessageLiteOrBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: AnyRef): Boolean
- Definition Classes
- SelectionInput → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def findInitializationErrors(): List[String]
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getAllFields(): Map[FieldDescriptor, AnyRef]
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDefaultInstanceForType(): SelectionInput
- Definition Classes
- SelectionInput → MessageOrBuilder → MessageLiteOrBuilder
- Annotations
- @Override()
- def getDescriptorForType(): Descriptor
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getExternalDataSource(): Action
An external data source, such as a relational data base.
An external data source, such as a relational data base.
.google.apps.card.v1.Action external_data_source = 8;
- returns
The externalDataSource.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getExternalDataSourceOrBuilder(): ActionOrBuilder
An external data source, such as a relational data base.
An external data source, such as a relational data base.
.google.apps.card.v1.Action external_data_source = 8;
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getField(arg0: FieldDescriptor): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getInitializationErrorString(): String
- Definition Classes
- AbstractMessage → MessageOrBuilder
- def getItems(index: Int): SelectionItem
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
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;
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getItemsCount(): Int
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
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;
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getItemsList(): List[SelectionItem]
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
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;
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getItemsOrBuilder(index: Int): SelectionItemOrBuilder
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
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;
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getItemsOrBuilderList(): List[_ <: SelectionItemOrBuilder]
An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
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;
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getLabel(): 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".
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getLabelBytes(): ByteString
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".
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getMultiSelectDataSourceCase(): MultiSelectDataSourceCase
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- def getMultiSelectMaxSelectedItems(): 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.
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getMultiSelectMinQueryLength(): 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. If unspecified, defaults to 0 characters for static data sources and 3 characters for external data sources.
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getName(): String
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).
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getNameBytes(): ByteString
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).
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getOnChangeAction(): 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](https://developers.google.com/workspace/chat/read-form-data).
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getOnChangeActionOrBuilder(): ActionOrBuilder
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).
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;
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
- def getParserForType(): Parser[SelectionInput]
- Definition Classes
- SelectionInput → GeneratedMessageV3 → Message → MessageLite
- Annotations
- @Override()
- def getPlatformDataSource(): PlatformDataSource
A data source from Google Workspace.
A data source from Google Workspace.
.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
- returns
The platformDataSource.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getPlatformDataSourceOrBuilder(): PlatformDataSourceOrBuilder
A data source from Google Workspace.
A data source from Google Workspace.
.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getRepeatedFieldCount(arg0: FieldDescriptor): Int
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def getSerializedSize(): Int
- Definition Classes
- SelectionInput → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
- def getType(): SelectionType
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.
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getTypeValue(): 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.
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def getUnknownFields(): UnknownFieldSet
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def hasExternalDataSource(): Boolean
An external data source, such as a relational data base.
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def hasField(arg0: FieldDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → MessageOrBuilder
- def hasOnChangeAction(): Boolean
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).
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.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def hasOneof(arg0: OneofDescriptor): Boolean
- Definition Classes
- GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
- def hasPlatformDataSource(): Boolean
A data source from Google Workspace.
A data source from Google Workspace.
.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
- returns
Whether the platformDataSource field is set.
- Definition Classes
- SelectionInput → SelectionInputOrBuilder
- Annotations
- @Override()
- def hashCode(): Int
- Definition Classes
- SelectionInput → AbstractMessage → Message → AnyRef → Any
- Annotations
- @Override()
- def internalGetFieldAccessorTable(): FieldAccessorTable
- Attributes
- protected[v1]
- Definition Classes
- SelectionInput → GeneratedMessageV3
- Annotations
- @Override()
- def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- final def isInitialized(): Boolean
- Definition Classes
- SelectionInput → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
- Annotations
- @Override()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def makeExtensionsImmutable(): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newBuilderForType(parent: BuilderParent): Builder
- Attributes
- protected[v1]
- Definition Classes
- SelectionInput → GeneratedMessageV3
- Annotations
- @Override()
- def newBuilderForType(): Builder
- Definition Classes
- SelectionInput → Message → MessageLite
- Annotations
- @Override()
- def newBuilderForType(arg0: BuilderParent): Builder
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3 → AbstractMessage
- def newInstance(unused: UnusedPrivateParameter): AnyRef
- Attributes
- protected[v1]
- Definition Classes
- SelectionInput → GeneratedMessageV3
- Annotations
- @Override() @SuppressWarnings()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.IOException])
- def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.IOException])
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toBuilder(): Builder
- Definition Classes
- SelectionInput → Message → MessageLite
- Annotations
- @Override()
- def toByteArray(): Array[Byte]
- Definition Classes
- AbstractMessageLite → MessageLite
- def toByteString(): ByteString
- Definition Classes
- AbstractMessageLite → MessageLite
- final def toString(): String
- Definition Classes
- AbstractMessage → Message → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def writeDelimitedTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])
- def writeReplace(): AnyRef
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[java.io.ObjectStreamException])
- def writeTo(output: CodedOutputStream): Unit
- Definition Classes
- SelectionInput → GeneratedMessageV3 → AbstractMessage → MessageLite
- Annotations
- @Override()
- def writeTo(arg0: OutputStream): Unit
- Definition Classes
- AbstractMessageLite → MessageLite
- Annotations
- @throws(classOf[java.io.IOException])
Deprecated Value Members
- def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
- Attributes
- protected[protobuf]
- Definition Classes
- GeneratedMessageV3
- Annotations
- @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
- Deprecated