Package com.google.apps.card.v1
Interface TextInputOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
TextInput
,TextInput.Builder
public interface TextInputOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionOptional.Optional.Text that appears below the text input field meant to assist users by prompting them to enter a certain value.com.google.protobuf.ByteString
Text that appears below the text input field meant to assist users by prompting them to enter a certain value.Suggested values that users can enter.Suggested values that users can enter.getLabel()
The text that appears above the text input field in the user interface.com.google.protobuf.ByteString
The text that appears above the text input field in the user interface.getName()
The name by which the text input is identified in a form input event.com.google.protobuf.ByteString
The name by which the text input is identified in a form input event.What to do when a change occurs in the text input field.What to do when a change occurs in the text input field.Text that appears in the text input field when the field is empty.com.google.protobuf.ByteString
Text that appears in the text input field when the field is empty.getType()
How a text input field appears in the user interface.int
How a text input field appears in the user interface.getValue()
The value entered by a user, returned as part of a form input event.com.google.protobuf.ByteString
The value entered by a user, returned as part of a form input event.boolean
Optional.boolean
Suggested values that users can enter.boolean
What to do when a change occurs in the text input field.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
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](https://developers.google.com/workspace/chat/read-form-data).
string name = 1;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.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](https://developers.google.com/workspace/chat/read-form-data).
string name = 1;
- Returns:
- The bytes for name.
-
getLabel
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:
- The label.
-
getLabelBytes
com.google.protobuf.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:
- The bytes for label.
-
getHintText
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:
- The hintText.
-
getHintTextBytes
com.google.protobuf.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:
- The bytes for hintText.
-
getValue
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](https://developers.google.com/workspace/chat/read-form-data).
string value = 4;
- Returns:
- The value.
-
getValueBytes
com.google.protobuf.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](https://developers.google.com/workspace/chat/read-form-data).
string value = 4;
- Returns:
- The bytes for value.
-
getTypeValue
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:
- The enum numeric value on the wire for type.
-
getType
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:
- The type.
-
hasOnChangeAction
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](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
.google.apps.card.v1.Action on_change_action = 6;
- Returns:
- Whether the onChangeAction field is set.
-
getOnChangeAction
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](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
.google.apps.card.v1.Action on_change_action = 6;
- Returns:
- The onChangeAction.
-
getOnChangeActionOrBuilder
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](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
.google.apps.card.v1.Action on_change_action = 6;
-
hasInitialSuggestions
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](https://developers.google.com/workspace/extend):
.google.apps.card.v1.Suggestions initial_suggestions = 7;
- Returns:
- Whether the initialSuggestions field is set.
-
getInitialSuggestions
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](https://developers.google.com/workspace/extend):
.google.apps.card.v1.Suggestions initial_suggestions = 7;
- Returns:
- The initialSuggestions.
-
getInitialSuggestionsOrBuilder
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](https://developers.google.com/workspace/extend):
.google.apps.card.v1.Suggestions initial_suggestions = 7;
-
hasAutoCompleteAction
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](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Action auto_complete_action = 8;
- Returns:
- Whether the autoCompleteAction field is set.
-
getAutoCompleteAction
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](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Action auto_complete_action = 8;
- Returns:
- The autoCompleteAction.
-
getAutoCompleteActionOrBuilder
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](https://developers.google.com/workspace/add-ons):
.google.apps.card.v1.Action auto_complete_action = 8;
-
getPlaceholderText
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](https://developers.google.com/workspace/chat):
string placeholder_text = 12;
- Returns:
- The placeholderText.
-
getPlaceholderTextBytes
com.google.protobuf.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](https://developers.google.com/workspace/chat):
string placeholder_text = 12;
- Returns:
- The bytes for placeholderText.
-