com.google.api.services.chat.v1.model

Class GoogleAppsCardV1Action

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 GenericJson

An action that describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form.

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

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()

Method Summary

Modifier and Type	Method and Description
GoogleAppsCardV1Action	clone()
String	getFunction() Apps Script function to invoke when the containing element is clicked/activated.
String	getLoadIndicator()
List<GoogleAppsCardV1ActionParameter>	getParameters() List of action parameters.
Boolean	getPersistValues() Indicates whether form values persist after the action.
GoogleAppsCardV1Action	set(String fieldName, Object value)
GoogleAppsCardV1Action	setFunction(String function) Apps Script function to invoke when the containing element is clicked/activated.
GoogleAppsCardV1Action	setLoadIndicator(String loadIndicator)
GoogleAppsCardV1Action	setParameters(List<GoogleAppsCardV1ActionParameter> parameters) List of action parameters.
GoogleAppsCardV1Action	setPersistValues(Boolean persistValues) Indicates whether form values persist after the action.

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

getFunction

public String getFunction()

Apps Script function to invoke when the containing element is clicked/activated.

Returns:

value or null for none

setFunction

public GoogleAppsCardV1Action setFunction(String function)

Apps Script function to invoke when the containing element is clicked/activated.

Parameters:

function - function or null for none

getLoadIndicator

public String getLoadIndicator()

Returns:

value or null for none

setLoadIndicator

public GoogleAppsCardV1Action setLoadIndicator(String loadIndicator)

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. When using [LoadIndicator.NONE](workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for actions, `persist_values` = `true`is recommended, as it ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response. If `false`, the form values are cleared when the action is triggered. When `persist_values` is set to `false`, it is strongly recommended that the card use [LoadIndicator.SPINNER](workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for all actions, as this locks the UI to ensure no changes are made by the user while the action is being processed.

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. When using [LoadIndicator.NONE](workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for actions, `persist_values` = `true`is recommended, as it ensures that any changes made by the user after form or on change actions are sent to the server are not overwritten by the response. If `false`, the form values are cleared when the action is triggered. When `persist_values` is set to `false`, it is strongly recommended that the card use [LoadIndicator.SPINNER](workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) for all actions, as this locks the UI to ensure no changes are made by the user while the action is being processed.

Parameters:

persistValues - persistValues or null for none

set

public GoogleAppsCardV1Action set(String fieldName,
                                  Object value)

Overrides:

set in class GenericJson

clone

public GoogleAppsCardV1Action clone()

Overrides:

clone in class GenericJson