public interface TextInputOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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.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.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.
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.
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.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. |