Interface TextInputOrBuilder (2.41.0)

Version 2.41.0

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface TextInputOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoCompleteAction()

public abstract Action getAutoCompleteAction()

Optional. Specify what action to take when the text input field provides suggestions to users who interact with it.

If unspecified, the suggestions are set by initialSuggestions and are processed by the client.

If specified, the app takes the action specified here, such as running a custom function.

Google Workspace Add-ons:

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

Returns
Type	Description
Action	The autoCompleteAction.

getAutoCompleteActionOrBuilder()

public abstract ActionOrBuilder getAutoCompleteActionOrBuilder()

Optional. Specify what action to take when the text input field provides suggestions to users who interact with it.

If unspecified, the suggestions are set by initialSuggestions and are processed by the client.

If specified, the app takes the action specified here, such as running a custom function.

Google Workspace Add-ons:

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

Returns
Type	Description
ActionOrBuilder

getHintText()

public abstract String getHintText()

Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible.

Required if label is unspecified. Otherwise, optional.

string hint_text = 3;

Returns
Type	Description
String	The hintText.

getHintTextBytes()

public abstract ByteString getHintTextBytes()

Text that appears below the text input field meant to assist users by prompting them to enter a certain value. This text is always visible.

Required if label is unspecified. Otherwise, optional.

string hint_text = 3;

Returns
Type	Description
ByteString	The bytes for hintText.

getInitialSuggestions()

public abstract Suggestions getInitialSuggestions()

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav, the list of suggestions filters to show just Java and JavaScript.

Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script. Suggesting JavaScript can standardize how users interact with your app.

When specified, TextInput.type is always SINGLE_LINE, even if it's set to MULTIPLE_LINE.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Suggestions initial_suggestions = 7;

Returns
Type	Description
Suggestions	The initialSuggestions.

getInitialSuggestionsOrBuilder()

public abstract SuggestionsOrBuilder getInitialSuggestionsOrBuilder()

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav, the list of suggestions filters to show just Java and JavaScript.

Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script. Suggesting JavaScript can standardize how users interact with your app.

When specified, TextInput.type is always SINGLE_LINE, even if it's set to MULTIPLE_LINE.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Suggestions initial_suggestions = 7;

Returns
Type	Description
SuggestionsOrBuilder

getLabel()

public abstract String getLabel()

The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write surname instead of name.

Required if hintText is unspecified. Otherwise, optional.

string label = 2;

Returns
Type	Description
String	The label.

getLabelBytes()

public abstract ByteString getLabelBytes()

The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs. For example, if you are asking someone's name, but specifically need their surname, write surname instead of name.

Required if hintText is unspecified. Otherwise, optional.

string label = 2;

Returns
Type	Description
ByteString	The bytes for label.

getName()

public abstract String getName()

The name by which the text input is identified 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 by which the text input is identified 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()

What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening a dialog in Google Chat.

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

Returns
Type	Description
Action	The onChangeAction.

getOnChangeActionOrBuilder()

public abstract ActionOrBuilder getOnChangeActionOrBuilder()

What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening a dialog in Google Chat.

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

Returns
Type	Description
ActionOrBuilder

getPlaceholderText()

public abstract String getPlaceholderText()

Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, Enter a number from 0 to 100.

Google Chat apps:

string placeholder_text = 12;

Returns
Type	Description
String	The placeholderText.

getPlaceholderTextBytes()

public abstract ByteString getPlaceholderTextBytes()

Text that appears in the text input field when the field is empty. Use this text to prompt users to enter a value. For example, Enter a number from 0 to 100.

Google Chat apps:

string placeholder_text = 12;

Returns
Type	Description
ByteString	The bytes for placeholderText.

getType()

public abstract TextInput.Type getType()

How a text input field appears in the user interface. For example, whether the field is single or multi-line.

.google.apps.card.v1.TextInput.Type type = 5;

Returns
Type	Description
TextInput.Type	The type.

getTypeValue()

public abstract int getTypeValue()

How a text input field appears in the user interface. For example, whether the field is single or multi-line.

.google.apps.card.v1.TextInput.Type type = 5;

Returns
Type	Description
int	The enum numeric value on the wire for type.

getValue()

public abstract String getValue()

The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see Receive form data.

string value = 4;

Returns
Type	Description
String	The value.

getValueBytes()

public abstract ByteString getValueBytes()

The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see Receive form data.

string value = 4;

Returns
Type	Description
ByteString	The bytes for value.

hasAutoCompleteAction()

public abstract boolean hasAutoCompleteAction()

Optional. Specify what action to take when the text input field provides suggestions to users who interact with it.

If unspecified, the suggestions are set by initialSuggestions and are processed by the client.

If specified, the app takes the action specified here, such as running a custom function.

Google Workspace Add-ons:

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

Returns
Type	Description
boolean	Whether the autoCompleteAction field is set.

hasInitialSuggestions()

public abstract boolean hasInitialSuggestions()

Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing Jav, the list of suggestions filters to show just Java and JavaScript.

Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter javascript and others java script. Suggesting JavaScript can standardize how users interact with your app.

When specified, TextInput.type is always SINGLE_LINE, even if it's set to MULTIPLE_LINE.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Suggestions initial_suggestions = 7;

Returns
Type	Description
boolean	Whether the initialSuggestions field is set.

hasOnChangeAction()

public abstract boolean hasOnChangeAction()

What to do when a change occurs in the text input field. For example, a user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening a dialog in Google Chat.

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

Returns
Type	Description
boolean	Whether the onChangeAction field is set.