Class GoogleAppsCardV1TextInput
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:
Implements
Inherited Members
Namespace: Google.Apis.HangoutsChat.v1.Data
Assembly: Google.Apis.HangoutsChat.v1.dll
Syntax
public class GoogleAppsCardV1TextInput : IDirectResponseSchema
Properties
AutoCompleteAction
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:
Declaration
[JsonProperty("autoCompleteAction")]
public virtual GoogleAppsCardV1Action AutoCompleteAction { get; set; }
Property Value
Type | Description |
---|---|
GoogleAppsCardV1Action |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
HintText
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.
Declaration
[JsonProperty("hintText")]
public virtual string HintText { get; set; }
Property Value
Type | Description |
---|---|
string |
InitialSuggestions
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:
Declaration
[JsonProperty("initialSuggestions")]
public virtual GoogleAppsCardV1Suggestions InitialSuggestions { get; set; }
Property Value
Type | Description |
---|---|
GoogleAppsCardV1Suggestions |
Label
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.
Declaration
[JsonProperty("label")]
public virtual string Label { get; set; }
Property Value
Type | Description |
---|---|
string |
Name
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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
OnChangeAction
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.
Declaration
[JsonProperty("onChangeAction")]
public virtual GoogleAppsCardV1Action OnChangeAction { get; set; }
Property Value
Type | Description |
---|---|
GoogleAppsCardV1Action |
PlaceholderText
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:
Declaration
[JsonProperty("placeholderText")]
public virtual string PlaceholderText { get; set; }
Property Value
Type | Description |
---|---|
string |
Type
How a text input field appears in the user interface. For example, whether the field is single or multi-line.
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type | Description |
---|---|
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.
Declaration
[JsonProperty("value")]
public virtual string Value { get; set; }
Property Value
Type | Description |
---|---|
string |