Reference documentation and code samples for the Google Apps Chat V1 Client class TextInput.
A field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see 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 . 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 :
Generated from protobuf message google.apps.card.v1.TextInput
Namespace
Google \ Apps \ Card \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
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 .
↳ label
string
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.
↳ hint_text
string
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.
↳ value
string
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 .
↳ type
int
How a text input field appears in the user interface. For example, whether the field is single or multi-line.
↳ on_change_action
Google\Apps\Card\V1\Action
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.
↳ initial_suggestions
Google\Apps\Card\V1\Suggestions
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
:
↳ auto_complete_action
Google\Apps\Card\V1\Action
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
:
↳ placeholder_text
string
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
:
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
setName
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 .
var
string
$this
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
setLabel
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.
var
string
$this
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
setHintText
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.
var
string
$this
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
setValue
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 .
var
string
$this
getType
How a text input field appears in the user interface.
For example, whether the field is single or multi-line.
int
setType
How a text input field appears in the user interface.
For example, whether the field is single or multi-line.
var
int
$this
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.
hasOnChangeAction
clearOnChangeAction
setOnChangeAction
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.
$this
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
:
hasInitialSuggestions
clearInitialSuggestions
setInitialSuggestions
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
:
$this
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
:
hasAutoCompleteAction
clearAutoCompleteAction
setAutoCompleteAction
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
:
$this
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
setPlaceholderText
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
:
var
string
$this
