GoogleAppsCardV1TextInput (Google Chat API v1-rev20251118-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.chat.v1.model.GoogleAppsCardV1TextInput

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleAppsCardV1TextInput
extends com.google.api.client.json.GenericJson
```
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 widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Chat API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleAppsCardV1TextInput()

Constructors
Constructor and Description
`GoogleAppsCardV1TextInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleAppsCardV1TextInput`	`clone()`
`GoogleAppsCardV1Action`	`getAutoCompleteAction()` Optional.
`String`	`getHintText()` Text that appears below the text input field meant to assist users by prompting them to enter a certain value.
`HostAppDataSourceMarkup`	`getHostAppDataSource()` A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages.
`GoogleAppsCardV1Suggestions`	`getInitialSuggestions()` Suggested values that users can enter.
`String`	`getLabel()` The text that appears above the text input field in the user interface.
`String`	`getName()` The name by which the text input is identified in a form input event.
`GoogleAppsCardV1Action`	`getOnChangeAction()` What to do when a change occurs in the text input field.
`String`	`getPlaceholderText()` Text that appears in the text input field when the field is empty.
`String`	`getType()` How a text input field appears in the user interface.
`GoogleAppsCardV1Validation`	`getValidation()` Specify the input format validation necessary for this text field.
`String`	`getValue()` The value entered by a user, returned as part of a form input event.
`GoogleAppsCardV1TextInput`	`set(String fieldName, Object value)`
`GoogleAppsCardV1TextInput`	`setAutoCompleteAction(GoogleAppsCardV1Action autoCompleteAction)` Optional.
`GoogleAppsCardV1TextInput`	`setHintText(String hintText)` Text that appears below the text input field meant to assist users by prompting them to enter a certain value.
`GoogleAppsCardV1TextInput`	`setHostAppDataSource(HostAppDataSourceMarkup hostAppDataSource)` A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages.
`GoogleAppsCardV1TextInput`	`setInitialSuggestions(GoogleAppsCardV1Suggestions initialSuggestions)` Suggested values that users can enter.
`GoogleAppsCardV1TextInput`	`setLabel(String label)` The text that appears above the text input field in the user interface.
`GoogleAppsCardV1TextInput`	`setName(String name)` The name by which the text input is identified in a form input event.
`GoogleAppsCardV1TextInput`	`setOnChangeAction(GoogleAppsCardV1Action onChangeAction)` What to do when a change occurs in the text input field.
`GoogleAppsCardV1TextInput`	`setPlaceholderText(String placeholderText)` Text that appears in the text input field when the field is empty.
`GoogleAppsCardV1TextInput`	`setType(String type)` How a text input field appears in the user interface.
`GoogleAppsCardV1TextInput`	`setValidation(GoogleAppsCardV1Validation validation)` Specify the input format validation necessary for this text field.
`GoogleAppsCardV1TextInput`	`setValue(String value)` The value entered by a user, returned as part of a form input event.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleAppsCardV1TextInput
```
public GoogleAppsCardV1TextInput()
```
- Method Detail
  - getAutoCompleteAction
```
public GoogleAppsCardV1Action 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):
    
    Returns:
    
    value or null for none
  - setAutoCompleteAction
```
public GoogleAppsCardV1TextInput setAutoCompleteAction(GoogleAppsCardV1Action 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](https://developers.google.com/workspace/add-ons):
    
    Parameters:
    
    autoCompleteAction - autoCompleteAction or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setHintText
```
public GoogleAppsCardV1TextInput setHintText(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.
    
    Parameters:
    
    hintText - hintText or null for none
  - getHostAppDataSource
```
public HostAppDataSourceMarkup getHostAppDataSource()
```
    A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.
    
    Returns:
    
    value or null for none
  - setHostAppDataSource
```
public GoogleAppsCardV1TextInput setHostAppDataSource(HostAppDataSourceMarkup hostAppDataSource)
```
    A data source that's unique to a Google Workspace host application, such as Gmail emails, Google Calendar events, or Google Chat messages. Available for Google Workspace add-ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.
    
    Parameters:
    
    hostAppDataSource - hostAppDataSource or null for none
  - getInitialSuggestions
```
public GoogleAppsCardV1Suggestions 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):
    
    Returns:
    
    value or null for none
  - setInitialSuggestions
```
public GoogleAppsCardV1TextInput setInitialSuggestions(GoogleAppsCardV1Suggestions 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](https://developers.google.com/workspace/extend):
    
    Parameters:
    
    initialSuggestions - initialSuggestions or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setLabel
```
public GoogleAppsCardV1TextInput setLabel(String 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.
    
    Parameters:
    
    label - label or null for none
  - 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](https://developers.google.com/workspace/chat/read- form-data).
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleAppsCardV1TextInput setName(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](https://developers.google.com/workspace/chat/read- form-data).
    
    Parameters:
    
    name - name or null for none
  - getOnChangeAction
```
public GoogleAppsCardV1Action 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.
    
    Returns:
    
    value or null for none
  - setOnChangeAction
```
public GoogleAppsCardV1TextInput setOnChangeAction(GoogleAppsCardV1Action 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](https://developers.google.com/workspace/chat/dialogs) in Google Chat.
    
    Parameters:
    
    onChangeAction - onChangeAction or null for none
  - 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`. [Google Chat apps](https://developers.google.com/workspace/chat):
    
    Returns:
    
    value or null for none
  - setPlaceholderText
```
public GoogleAppsCardV1TextInput setPlaceholderText(String 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](https://developers.google.com/workspace/chat):
    
    Parameters:
    
    placeholderText - placeholderText or null for none
  - getType
```
public String getType()
```
    How a text input field appears in the user interface. For example, whether the field is single or multi-line.
    
    Returns:
    
    value or null for none
  - setType
```
public GoogleAppsCardV1TextInput setType(String type)
```
    How a text input field appears in the user interface. For example, whether the field is single or multi-line.
    
    Parameters:
    
    type - type or null for none
  - getValidation
```
public GoogleAppsCardV1Validation getValidation()
```
    Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
    
    Returns:
    
    value or null for none
  - setValidation
```
public GoogleAppsCardV1TextInput setValidation(GoogleAppsCardV1Validation validation)
```
    Specify the input format validation necessary for this text field. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
    
    Parameters:
    
    validation - validation or null for none
  - 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](https://developers.google.com/workspace/chat/read- form-data).
    
    Returns:
    
    value or null for none
  - setValue
```
public GoogleAppsCardV1TextInput 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](https://developers.google.com/workspace/chat/read- form-data).
    
    Parameters:
    
    value - value or null for none
  - set
```
public GoogleAppsCardV1TextInput set(String fieldName,
                                     Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleAppsCardV1TextInput clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleAppsCardV1TextInput

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleAppsCardV1TextInput

Method Detail

getAutoCompleteAction

setAutoCompleteAction

getHintText

setHintText

getHostAppDataSource

setHostAppDataSource

getInitialSuggestions

setInitialSuggestions

getLabel

setLabel

getName

setName

getOnChangeAction

setOnChangeAction

getPlaceholderText

setPlaceholderText

getType

setType

getValidation

setValidation

getValue

setValue

set

clone