public static final class TextInput.Builder extends GeneratedMessageV3.Builder<TextInput.Builder> implements TextInputOrBuilderA field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see Text input.
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.
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 widget.
Google Workspace Add-ons and Chat apps:
Protobuf type google.apps.card.v1.TextInput
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TextInput.BuilderImplements
TextInputOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TextInput.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
build()
public TextInput build()| Returns | |
|---|---|
| Type | Description |
TextInput | |
buildPartial()
public TextInput buildPartial()| Returns | |
|---|---|
| Type | Description |
TextInput | |
clear()
public TextInput.Builder clear()| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
clearAutoCompleteAction()
public TextInput.Builder clearAutoCompleteAction()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 |
TextInput.Builder | |
clearField(Descriptors.FieldDescriptor field)
public TextInput.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
clearHintText()
public TextInput.Builder clearHintText()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 |
TextInput.Builder | This builder for chaining. |
clearInitialSuggestions()
public TextInput.Builder clearInitialSuggestions()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 |
TextInput.Builder | |
clearLabel()
public TextInput.Builder clearLabel()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 |
TextInput.Builder | This builder for chaining. |
clearName()
public TextInput.Builder clearName()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 |
TextInput.Builder | This builder for chaining. |
clearOnChangeAction()
public TextInput.Builder clearOnChangeAction()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 |
TextInput.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public TextInput.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
clearPlaceholderText()
public TextInput.Builder clearPlaceholderText() 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 |
TextInput.Builder | This builder for chaining. |
clearType()
public TextInput.Builder clearType()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.Builder | This builder for chaining. |
clearValue()
public TextInput.Builder clearValue()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 |
TextInput.Builder | This builder for chaining. |
clone()
public TextInput.Builder clone()| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
getAutoCompleteAction()
public 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. |
getAutoCompleteActionBuilder()
public Action.Builder getAutoCompleteActionBuilder()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.Builder | |
getAutoCompleteActionOrBuilder()
public 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 | |
getDefaultInstanceForType()
public TextInput getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TextInput | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getHintText()
public 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 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 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. |
getInitialSuggestionsBuilder()
public Suggestions.Builder getInitialSuggestionsBuilder()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.Builder | |
getInitialSuggestionsOrBuilder()
public 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 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 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 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 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 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. |
getOnChangeActionBuilder()
public Action.Builder getOnChangeActionBuilder()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.Builder | |
getOnChangeActionOrBuilder()
public 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 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 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeAutoCompleteAction(Action value)
public TextInput.Builder mergeAutoCompleteAction(Action value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Action |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
mergeFrom(TextInput other)
public TextInput.Builder mergeFrom(TextInput other)| Parameter | |
|---|---|
| Name | Description |
other | TextInput |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TextInput.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public TextInput.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
mergeInitialSuggestions(Suggestions value)
public TextInput.Builder mergeInitialSuggestions(Suggestions value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Suggestions |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
mergeOnChangeAction(Action value)
public TextInput.Builder mergeOnChangeAction(Action value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Action |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TextInput.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setAutoCompleteAction(Action value)
public TextInput.Builder setAutoCompleteAction(Action value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Action |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setAutoCompleteAction(Action.Builder builderForValue)
public TextInput.Builder setAutoCompleteAction(Action.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Action.Builder |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public TextInput.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setHintText(String value)
public TextInput.Builder setHintText(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe hintText to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setHintTextBytes(ByteString value)
public TextInput.Builder setHintTextBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for hintText to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setInitialSuggestions(Suggestions value)
public TextInput.Builder setInitialSuggestions(Suggestions value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Suggestions |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setInitialSuggestions(Suggestions.Builder builderForValue)
public TextInput.Builder setInitialSuggestions(Suggestions.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Suggestions.Builder |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setLabel(String value)
public TextInput.Builder setLabel(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe label to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setLabelBytes(ByteString value)
public TextInput.Builder setLabelBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for label to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setName(String value)
public TextInput.Builder setName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public TextInput.Builder setNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setOnChangeAction(Action value)
public TextInput.Builder setOnChangeAction(Action value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Action |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setOnChangeAction(Action.Builder builderForValue)
public TextInput.Builder setOnChangeAction(Action.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Action.Builder |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setPlaceholderText(String value)
public TextInput.Builder setPlaceholderText(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe placeholderText to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setPlaceholderTextBytes(ByteString value)
public TextInput.Builder setPlaceholderTextBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for placeholderText to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TextInput.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setType(TextInput.Type value)
public TextInput.Builder setType(TextInput.Type value)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;
| Parameter | |
|---|---|
| Name | Description |
value | TextInput.TypeThe type to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setTypeValue(int value)
public TextInput.Builder setTypeValue(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for type to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final TextInput.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | |
setValue(String value)
public TextInput.Builder setValue(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe value to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |
setValueBytes(ByteString value)
public TextInput.Builder setValueBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for value to set. |
| Returns | |
|---|---|
| Type | Description |
TextInput.Builder | This builder for chaining. |