Interface SelectionInputOrBuilder (2.40.0) 

public interface SelectionInputOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExternalDataSource()

public abstract Action getExternalDataSource()

An external data source, such as a relational data base.

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

Returns
Type Description
Action

The externalDataSource.

getExternalDataSourceOrBuilder()

public abstract ActionOrBuilder getExternalDataSourceOrBuilder()

An external data source, such as a relational data base.

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

Returns
Type Description
ActionOrBuilder

getItems(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
SelectionInput.SelectionItem

getItemsCount()

public abstract 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;

Returns
Type Description
int

getItemsList()

public abstract 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;

Returns
Type Description
List<SelectionItem>

getItemsOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
SelectionInput.SelectionItemOrBuilder

getItemsOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.apps.card.v1.SelectionInput.SelectionItemOrBuilder>

getLabel()

public abstract 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;

Returns
Type Description
String

The label.

getLabelBytes()

public abstract 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;

Returns
Type Description
ByteString

The bytes for label.

getMultiSelectDataSourceCase()

public abstract SelectionInput.MultiSelectDataSourceCase getMultiSelectDataSourceCase()
Returns
Type Description
SelectionInput.MultiSelectDataSourceCase

getMultiSelectMaxSelectedItems()

public abstract 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;

Returns
Type Description
int

The multiSelectMaxSelectedItems.

getMultiSelectMinQueryLength()

public abstract 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;

Returns
Type Description
int

The multiSelectMinQueryLength.

getName()

public abstract 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.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract 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.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOnChangeAction()

public abstract 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.

.google.apps.card.v1.Action on_change_action = 5;

Returns
Type Description
Action

The onChangeAction.

getOnChangeActionOrBuilder()

public abstract 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.

.google.apps.card.v1.Action on_change_action = 5;

Returns
Type Description
ActionOrBuilder

getPlatformDataSource()

public abstract SelectionInput.PlatformDataSource getPlatformDataSource()

A data source from Google Workspace.

.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;

Returns
Type Description
SelectionInput.PlatformDataSource

The platformDataSource.

getPlatformDataSourceOrBuilder()

public abstract SelectionInput.PlatformDataSourceOrBuilder getPlatformDataSourceOrBuilder()

A data source from Google Workspace.

.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;

Returns
Type Description
SelectionInput.PlatformDataSourceOrBuilder

getType()

public abstract 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;

Returns
Type Description
SelectionInput.SelectionType

The type.

getTypeValue()

public abstract 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;

Returns
Type Description
int

The enum numeric value on the wire for type.

hasExternalDataSource()

public abstract boolean hasExternalDataSource()

An external data source, such as a relational data base.

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

Returns
Type Description
boolean

Whether the externalDataSource field is set.

hasOnChangeAction()

public abstract 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.

.google.apps.card.v1.Action on_change_action = 5;

Returns
Type Description
boolean

Whether the onChangeAction field is set.

hasPlatformDataSource()

public abstract boolean hasPlatformDataSource()

A data source from Google Workspace.

.google.apps.card.v1.SelectionInput.PlatformDataSource platform_data_source = 9;

Returns
Type Description
boolean

Whether the platformDataSource field is set.