GoogleAppsCardV1Action (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.GoogleAppsCardV1Action

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleAppsCardV1Action
extends com.google.api.client.json.GenericJson
```
An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server. [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

GoogleAppsCardV1Action()

Constructors
Constructor and Description
`GoogleAppsCardV1Action()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleAppsCardV1Action`	`clone()`
`Boolean`	`getAllWidgetsAreRequired()` Optional.
`String`	`getFunction()` A custom function to invoke when the containing element is clicked or otherwise activated.
`String`	`getInteraction()` Optional.
`String`	`getLoadIndicator()` Specifies the loading indicator that the action displays while making the call to the action.
`List<GoogleAppsCardV1ActionParameter>`	`getParameters()` List of action parameters.
`Boolean`	`getPersistValues()` Indicates whether form values persist after the action.
`List<String>`	`getRequiredWidgets()` Optional.
`GoogleAppsCardV1Action`	`set(String fieldName, Object value)`
`GoogleAppsCardV1Action`	`setAllWidgetsAreRequired(Boolean allWidgetsAreRequired)` Optional.
`GoogleAppsCardV1Action`	`setFunction(String function)` A custom function to invoke when the containing element is clicked or otherwise activated.
`GoogleAppsCardV1Action`	`setInteraction(String interaction)` Optional.
`GoogleAppsCardV1Action`	`setLoadIndicator(String loadIndicator)` Specifies the loading indicator that the action displays while making the call to the action.
`GoogleAppsCardV1Action`	`setParameters(List<GoogleAppsCardV1ActionParameter> parameters)` List of action parameters.
`GoogleAppsCardV1Action`	`setPersistValues(Boolean persistValues)` Indicates whether form values persist after the action.
`GoogleAppsCardV1Action`	`setRequiredWidgets(List<String> requiredWidgets)` Optional.

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
  - GoogleAppsCardV1Action
```
public GoogleAppsCardV1Action()
```
- Method Detail
  - getAllWidgetsAreRequired
```
public Boolean getAllWidgetsAreRequired()
```
    Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
    
    Returns:
    
    value or null for none
  - setAllWidgetsAreRequired
```
public GoogleAppsCardV1Action setAllWidgetsAreRequired(Boolean allWidgetsAreRequired)
```
    Optional. If this is true, then all widgets are considered required by this action. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
    
    Parameters:
    
    allWidgetsAreRequired - allWidgetsAreRequired or null for none
  - getFunction
```
public String getFunction()
```
    A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form- data).
    
    Returns:
    
    value or null for none
  - setFunction
```
public GoogleAppsCardV1Action setFunction(String function)
```
    A custom function to invoke when the containing element is clicked or otherwise activated. For example usage, see [Read form data](https://developers.google.com/workspace/chat/read-form- data).
    
    Parameters:
    
    function - function or null for none
  - getInteraction
```
public String getInteraction()
```
    Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
    
    Returns:
    
    value or null for none
  - setInteraction
```
public GoogleAppsCardV1Action setInteraction(String interaction)
```
    Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs). What to do in response to an interaction with a user, such as a user clicking a button in a card message. If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal. By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs). When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client. [Google Chat apps](https://developers.google.com/workspace/chat):
    
    Parameters:
    
    interaction - interaction or null for none
  - getLoadIndicator
```
public String getLoadIndicator()
```
    Specifies the loading indicator that the action displays while making the call to the action.
    
    Returns:
    
    value or null for none
  - setLoadIndicator
```
public GoogleAppsCardV1Action setLoadIndicator(String loadIndicator)
```
    Specifies the loading indicator that the action displays while making the call to the action.
    
    Parameters:
    
    loadIndicator - loadIndicator or null for none
  - getParameters
```
public List<GoogleAppsCardV1ActionParameter> getParameters()
```
    List of action parameters.
    
    Returns:
    
    value or null for none
  - setParameters
```
public GoogleAppsCardV1Action setParameters(List<GoogleAppsCardV1ActionParameter> parameters)
```
    List of action parameters.
    
    Parameters:
    
    parameters - parameters or null for none
  - getPersistValues
```
public Boolean getPersistValues()
```
    Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add- ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/worksp ace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.mess ages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add- ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
    
    Returns:
    
    value or null for none
  - setPersistValues
```
public GoogleAppsCardV1Action setPersistValues(Boolean persistValues)
```
    Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add- ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/worksp ace/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.mess ages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add- ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.
    
    Parameters:
    
    persistValues - persistValues or null for none
  - getRequiredWidgets
```
public List<String> getRequiredWidgets()
```
    Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
    
    Returns:
    
    value or null for none
  - setRequiredWidgets
```
public GoogleAppsCardV1Action setRequiredWidgets(List<String> requiredWidgets)
```
    Optional. Fill this list with the names of widgets that this Action needs for a valid submission. If the widgets listed here don't have a value when this Action is invoked, the form submission is aborted. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
    
    Parameters:
    
    requiredWidgets - requiredWidgets or null for none
  - set
```
public GoogleAppsCardV1Action set(String fieldName,
                                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleAppsCardV1Action clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleAppsCardV1Action

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

GoogleAppsCardV1Action

Method Detail

getAllWidgetsAreRequired

setAllWidgetsAreRequired

getFunction

setFunction

getInteraction

setInteraction

getLoadIndicator

setLoadIndicator

getParameters

setParameters

getPersistValues

setPersistValues

getRequiredWidgets

setRequiredWidgets

set

clone