Package com.google.apps.card.v1

Class SelectionInput

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.apps.card.v1.SelectionInput
All Implemented Interfaces:
SelectionInputOrBuilder, 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:

  • 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

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getMultiSelectDataSourceCase

      public SelectionInput.MultiSelectDataSourceCase getMultiSelectDataSourceCase()
      Specified by:
      getMultiSelectDataSourceCase in interface SelectionInputOrBuilder

    • getName

      public 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;
      Specified by:
      getName in interface SelectionInputOrBuilder
      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 interface SelectionInputOrBuilder
      Returns:
      The bytes for name.

    • getLabel

      public 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;
      Specified by:
      getLabel in interface SelectionInputOrBuilder
      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 interface SelectionInputOrBuilder
      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 interface SelectionInputOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public 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;
      Specified by:
      getType in interface SelectionInputOrBuilder
      Returns:
      The type.

    • getItemsList

      public 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;
      Specified by:
      getItemsList in interface SelectionInputOrBuilder

    • getItemsOrBuilderList

      public 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;
      Specified by:
      getItemsOrBuilderList in interface SelectionInputOrBuilder

    • 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 interface SelectionInputOrBuilder

    • getItems

      public 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;
      Specified by:
      getItems in interface SelectionInputOrBuilder

    • getItemsOrBuilder

      public 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;
      Specified by:
      getItemsOrBuilder in interface SelectionInputOrBuilder

    • 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 interface SelectionInputOrBuilder
      Returns:
      Whether the onChangeAction field is set.

    • getOnChangeAction

      public 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;
      Specified by:
      getOnChangeAction in interface SelectionInputOrBuilder
      Returns:
      The onChangeAction.

    • getOnChangeActionOrBuilder

      public 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;
      Specified by:
      getOnChangeActionOrBuilder in interface SelectionInputOrBuilder

    • 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 interface SelectionInputOrBuilder
      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 interface SelectionInputOrBuilder
      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 interface SelectionInputOrBuilder
      Returns:
      Whether the externalDataSource field is set.

    • getExternalDataSource

      public Action getExternalDataSource()
       An external data source, such as a relational data base.
      .google.apps.card.v1.Action external_data_source = 8;
      Specified by:
      getExternalDataSource in interface SelectionInputOrBuilder
      Returns:
      The externalDataSource.

    • getExternalDataSourceOrBuilder

      public ActionOrBuilder getExternalDataSourceOrBuilder()
       An external data source, such as a relational data base.
      .google.apps.card.v1.Action external_data_source = 8;
      Specified by:
      getExternalDataSourceOrBuilder in interface SelectionInputOrBuilder

    • hasPlatformDataSource

      public boolean hasPlatformDataSource()
       A data source from Google Workspace.
      .google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
      Specified by:
      hasPlatformDataSource in interface SelectionInputOrBuilder
      Returns:
      Whether the platformDataSource field is set.

    • getPlatformDataSource

      public SelectionInput.PlatformDataSource getPlatformDataSource()
       A data source from Google Workspace.
      .google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
      Specified by:
      getPlatformDataSource in interface SelectionInputOrBuilder
      Returns:
      The platformDataSource.

    • getPlatformDataSourceOrBuilder

      public SelectionInput.PlatformDataSourceOrBuilder getPlatformDataSourceOrBuilder()
       A data source from Google Workspace.
      .google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;
      Specified by:
      getPlatformDataSourceOrBuilder in interface SelectionInputOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.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

      public static SelectionInput parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SelectionInput parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SelectionInput parseDelimitedFrom(InputStream input) throws IOException
      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

      public SelectionInput.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SelectionInput.Builder newBuilder()

    • newBuilder

      public static SelectionInput.Builder newBuilder(SelectionInput prototype)

    • toBuilder

      public SelectionInput.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SelectionInput.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static SelectionInput getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SelectionInput> parser()

    • getParserForType

      public com.google.protobuf.Parser<SelectionInput> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public SelectionInput getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder