Package com.google.apps.card.v1
Class TextInput
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.apps.card.v1.TextInput
- All Implemented Interfaces:
TextInputOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
public final class TextInput
extends com.google.protobuf.GeneratedMessageV3
implements TextInputOrBuilder
A field in which users can enter text. Supports suggestions and on-change actions. Supports form submission validation. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is entered. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text). Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the [SelectionInput][google.apps.card.v1.SelectionInput] widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):Protobuf type
google.apps.card.v1.TextInput- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA field in which users can enter text.static enumHow a text input field appears in the user interface.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanOptional.Optional.static TextInputstatic final com.google.protobuf.Descriptors.DescriptorText that appears below the text input field meant to assist users by prompting them to enter a certain value.com.google.protobuf.ByteStringText 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.ByteStringThe 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.ByteStringThe 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.com.google.protobuf.Parser<TextInput>Text that appears in the text input field when the field is empty.com.google.protobuf.ByteStringText that appears in the text input field when the field is empty.intgetType()How a text input field appears in the user interface.intHow a text input field appears in the user interface.Specify the input format validation necessary for this text field.Specify the input format validation necessary for this text field.getValue()The value entered by a user, returned as part of a form input event.com.google.protobuf.ByteStringThe value entered by a user, returned as part of a form input event.booleanOptional.inthashCode()booleanSuggested values that users can enter.booleanWhat to do when a change occurs in the text input field.booleanSpecify the input format validation necessary for this text field.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic TextInput.Builderstatic TextInput.BuildernewBuilder(TextInput prototype) protected TextInput.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static TextInputparseDelimitedFrom(InputStream input) static TextInputparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TextInputparseFrom(byte[] data) static TextInputparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TextInputparseFrom(com.google.protobuf.ByteString data) static TextInputparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TextInputparseFrom(com.google.protobuf.CodedInputStream input) static TextInputparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TextInputparseFrom(InputStream input) static TextInputparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TextInputparseFrom(ByteBuffer data) static TextInputparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<TextInput>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
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:
-
HINT_TEXT_FIELD_NUMBER
public static final int HINT_TEXT_FIELD_NUMBER- See Also:
-
VALUE_FIELD_NUMBER
public static final int VALUE_FIELD_NUMBER- See Also:
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER- See Also:
-
ON_CHANGE_ACTION_FIELD_NUMBER
public static final int ON_CHANGE_ACTION_FIELD_NUMBER- See Also:
-
INITIAL_SUGGESTIONS_FIELD_NUMBER
public static final int INITIAL_SUGGESTIONS_FIELD_NUMBER- See Also:
-
AUTO_COMPLETE_ACTION_FIELD_NUMBER
public static final int AUTO_COMPLETE_ACTION_FIELD_NUMBER- See Also:
-
VALIDATION_FIELD_NUMBER
public static final int VALIDATION_FIELD_NUMBER- See Also:
-
PLACEHOLDER_TEXT_FIELD_NUMBER
public static final int PLACEHOLDER_TEXT_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
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;- Specified by:
getNamein interfaceTextInputOrBuilder- Returns:
- The name.
-
getNameBytes
public 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;- Specified by:
getNameBytesin interfaceTextInputOrBuilder- Returns:
- The bytes for name.
-
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;- Specified by:
getLabelin interfaceTextInputOrBuilder- Returns:
- The label.
-
getLabelBytes
public 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;- Specified by:
getLabelBytesin interfaceTextInputOrBuilder- Returns:
- The bytes for label.
-
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;- Specified by:
getHintTextin interfaceTextInputOrBuilder- Returns:
- The hintText.
-
getHintTextBytes
public 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;- Specified by:
getHintTextBytesin interfaceTextInputOrBuilder- Returns:
- The bytes for hintText.
-
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;- Specified by:
getValuein interfaceTextInputOrBuilder- Returns:
- The value.
-
getValueBytes
public 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;- Specified by:
getValueBytesin interfaceTextInputOrBuilder- Returns:
- The bytes for value.
-
getTypeValue
public 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;- Specified by:
getTypeValuein interfaceTextInputOrBuilder- Returns:
- The enum numeric value on the wire for 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;- Specified by:
getTypein interfaceTextInputOrBuilder- Returns:
- The type.
-
hasOnChangeAction
public 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;- Specified by:
hasOnChangeActionin interfaceTextInputOrBuilder- Returns:
- Whether the onChangeAction field is set.
-
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;- Specified by:
getOnChangeActionin interfaceTextInputOrBuilder- Returns:
- The onChangeAction.
-
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;- Specified by:
getOnChangeActionOrBuilderin interfaceTextInputOrBuilder
-
hasInitialSuggestions
public 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;- Specified by:
hasInitialSuggestionsin interfaceTextInputOrBuilder- Returns:
- Whether the initialSuggestions field is set.
-
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;- Specified by:
getInitialSuggestionsin interfaceTextInputOrBuilder- Returns:
- The initialSuggestions.
-
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;- Specified by:
getInitialSuggestionsOrBuilderin interfaceTextInputOrBuilder
-
hasAutoCompleteAction
public 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;- Specified by:
hasAutoCompleteActionin interfaceTextInputOrBuilder- Returns:
- Whether the autoCompleteAction field is set.
-
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;- Specified by:
getAutoCompleteActionin interfaceTextInputOrBuilder- Returns:
- The autoCompleteAction.
-
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;- Specified by:
getAutoCompleteActionOrBuilderin interfaceTextInputOrBuilder
-
hasValidation
public boolean hasValidation()Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
.google.apps.card.v1.Validation validation = 11;- Specified by:
hasValidationin interfaceTextInputOrBuilder- Returns:
- Whether the validation field is set.
-
getValidation
Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
.google.apps.card.v1.Validation validation = 11;- Specified by:
getValidationin interfaceTextInputOrBuilder- Returns:
- The validation.
-
getValidationOrBuilder
Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
.google.apps.card.v1.Validation validation = 11;- Specified by:
getValidationOrBuilderin interfaceTextInputOrBuilder
-
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;- Specified by:
getPlaceholderTextin interfaceTextInputOrBuilder- Returns:
- The placeholderText.
-
getPlaceholderTextBytes
public 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;- Specified by:
getPlaceholderTextBytesin interfaceTextInputOrBuilder- Returns:
- The bytes for placeholderText.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static TextInput parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TextInput parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TextInput parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TextInput parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TextInput parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TextInput parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static TextInput parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static TextInput parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static TextInput parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected TextInput.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-