c

com.google.apps.card.v1

SelectionInput

final class SelectionInput extends GeneratedMessageV3 with SelectionInputOrBuilder

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](/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
Linear Supertypes
SelectionInputOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SelectionInput
  2. SelectionInputOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    SelectionInput → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getDefaultInstanceForType(): SelectionInput
    Definition Classes
    SelectionInput → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  13. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  14. def getExternalDataSource(): Action

    An external data source, such as a relational database.


    An external data source, such as a relational database.

    .google.apps.card.v1.Action external_data_source = 8;

    returns

    The externalDataSource.

    Definition Classes
    SelectionInput → SelectionInputOrBuilder
    Annotations
    @Override()
  15. def getExternalDataSourceOrBuilder(): ActionOrBuilder

    An external data source, such as a relational database.


    An external data source, such as a relational database.

    .google.apps.card.v1.Action external_data_source = 8;

    Definition Classes
    SelectionInput → SelectionInputOrBuilder
    Annotations
    @Override()
  16. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  17. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  18. 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()
  19. 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()
  20. 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()
  21. 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()
  22. 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()
  23. 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()
  24. 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()
  25. def getMultiSelectDataSourceCase(): MultiSelectDataSourceCase
    Definition Classes
    SelectionInput → SelectionInputOrBuilder
  26. 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.

    optional int32 multi_select_max_selected_items = 6;

    returns

    The multiSelectMaxSelectedItems.

    Definition Classes
    SelectionInput → SelectionInputOrBuilder
    Annotations
    @Override()
  27. def getMultiSelectMinQueryLength(): 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.


    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.

    int32 multi_select_min_query_length = 7;

    returns

    The multiSelectMinQueryLength.

    Definition Classes
    SelectionInput → SelectionInputOrBuilder
    Annotations
    @Override()
  28. def getName(): 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](https://developers.google.com/workspace/chat/read-form-data).


    Required. 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()
  29. def getNameBytes(): ByteString

    Required. 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).


    Required. 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()
  30. 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()
  31. 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()
  32. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  33. def getParserForType(): Parser[SelectionInput]
    Definition Classes
    SelectionInput → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  34. 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()
  35. 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()
  36. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  37. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  38. def getSerializedSize(): Int
    Definition Classes
    SelectionInput → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  39. 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()
  40. 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()
  41. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  42. def hasExternalDataSource(): Boolean

    An external data source, such as a relational database.


    An external data source, such as a relational database.

    .google.apps.card.v1.Action external_data_source = 8;

    returns

    Whether the externalDataSource field is set.

    Definition Classes
    SelectionInput → SelectionInputOrBuilder
    Annotations
    @Override()
  43. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  44. def hasMultiSelectMaxSelectedItems(): Boolean

    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.

    optional int32 multi_select_max_selected_items = 6;

    returns

    Whether the multiSelectMaxSelectedItems field is set.

    Definition Classes
    SelectionInput → SelectionInputOrBuilder
    Annotations
    @Override()
  45. 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()
  46. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  47. 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()
  48. def hashCode(): Int
    Definition Classes
    SelectionInput → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  49. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    SelectionInput → GeneratedMessageV3
    Annotations
    @Override()
  50. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  51. final def isInitialized(): Boolean
    Definition Classes
    SelectionInput → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  52. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  53. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  54. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  55. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    SelectionInput → GeneratedMessageV3
    Annotations
    @Override()
  56. def newBuilderForType(): Builder
    Definition Classes
    SelectionInput → Message → MessageLite
    Annotations
    @Override()
  57. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  58. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    SelectionInput → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  59. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  61. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  62. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  63. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  64. def toBuilder(): Builder
    Definition Classes
    SelectionInput → Message → MessageLite
    Annotations
    @Override()
  65. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  66. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  67. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  71. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  72. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  73. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    SelectionInput → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  74. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from SelectionInputOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped