Packages

final case class SelectionInput(name: String = "", label: String = "", type: SelectionType = com.google.apps.card.v1.card.SelectionInput.SelectionType.CHECK_BOX, items: Seq[SelectionItem] = _root_.scala.Seq.empty, onChangeAction: Option[Action] = _root_.scala.None, multiSelectMaxSelectedItems: Int = 0, multiSelectMinQueryLength: Int = 0, multiSelectDataSource: MultiSelectDataSource = com.google.apps.card.v1.card.SelectionInput.MultiSelectDataSource.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SelectionInput] with Product with Serializable

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):

name

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

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".

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.

items

An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.

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](https://developers.google.com/workspace/chat/read-form-data).

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.

multiSelectMinQueryLength

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.

Annotations
@SerialVersionUID()
Source
SelectionInput.scala
Linear Supertypes
Updatable[SelectionInput], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SelectionInput
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SelectionInput(name: String = "", label: String = "", type: SelectionType = com.google.apps.card.v1.card.SelectionInput.SelectionType.CHECK_BOX, items: Seq[SelectionItem] = _root_.scala.Seq.empty, onChangeAction: Option[Action] = _root_.scala.None, multiSelectMaxSelectedItems: Int = 0, multiSelectMinQueryLength: Int = 0, multiSelectDataSource: MultiSelectDataSource = com.google.apps.card.v1.card.SelectionInput.MultiSelectDataSource.Empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    name

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

    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".

    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.

    items

    An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.

    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](https://developers.google.com/workspace/chat/read-form-data).

    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.

    multiSelectMinQueryLength

    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.

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. def addAllItems(__vs: Iterable[SelectionItem]): SelectionInput
  5. def addItems(__vs: SelectionItem*): SelectionInput
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearItems: SelectionInput
  8. def clearMultiSelectDataSource: SelectionInput
  9. def clearOnChangeAction: SelectionInput
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def companion: SelectionInput.type
    Definition Classes
    SelectionInput → GeneratedMessage
  12. def discardUnknownFields: SelectionInput
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getExternalDataSource: Action
  17. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    SelectionInput → GeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    SelectionInput → GeneratedMessage
  19. def getOnChangeAction: Action
  20. def getPlatformDataSource: PlatformDataSource
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val items: Seq[SelectionItem]
  23. val label: String
  24. val multiSelectDataSource: MultiSelectDataSource
  25. val multiSelectMaxSelectedItems: Int
  26. val multiSelectMinQueryLength: Int
  27. val name: String
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. val onChangeAction: Option[Action]
  32. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. def serializedSize: Int
    Definition Classes
    SelectionInput → GeneratedMessage
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  36. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  37. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  38. def toProtoString: String
    Definition Classes
    SelectionInput → GeneratedMessage
  39. val type: SelectionType
  40. val unknownFields: UnknownFieldSet
  41. def update(ms: (Lens[SelectionInput, SelectionInput]) => Mutation[SelectionInput]*): SelectionInput
    Definition Classes
    Updatable
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. def withExternalDataSource(__v: Action): SelectionInput
  46. def withItems(__v: Seq[SelectionItem]): SelectionInput
  47. def withLabel(__v: String): SelectionInput
  48. def withMultiSelectDataSource(__v: MultiSelectDataSource): SelectionInput
  49. def withMultiSelectMaxSelectedItems(__v: Int): SelectionInput
  50. def withMultiSelectMinQueryLength(__v: Int): SelectionInput
  51. def withName(__v: String): SelectionInput
  52. def withOnChangeAction(__v: Action): SelectionInput
  53. def withPlatformDataSource(__v: PlatformDataSource): SelectionInput
  54. def withType(__v: SelectionType): SelectionInput
  55. def withUnknownFields(__v: UnknownFieldSet): SelectionInput
  56. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  57. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    SelectionInput → GeneratedMessage
  58. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[SelectionInput]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped