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

Class FormAction

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.FormAction

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class FormAction
extends GenericJson

A form action 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
FormAction()

Method Summary

Modifier and Type	Method and Description
FormAction	clone()
String	getActionMethodName() The method name is used to identify which part of the form triggered the form submission.
List<ActionParameter>	getParameters() List of action parameters.
FormAction	set(String fieldName, Object value)
FormAction	setActionMethodName(String actionMethodName) The method name is used to identify which part of the form triggered the form submission.
FormAction	setParameters(List<ActionParameter> parameters) List of action parameters.

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

FormAction

public FormAction()

Method Detail

getActionMethodName

public String getActionMethodName()

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the bot as part of the card click event. The same method name can be used for several elements that trigger a common behavior if desired.

Returns:

value or null for none

setActionMethodName

public FormAction setActionMethodName(String actionMethodName)

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the bot as part of the card click event. The same method name can be used for several elements that trigger a common behavior if desired.

Parameters:

actionMethodName - actionMethodName or null for none

getParameters

public List<ActionParameter> getParameters()

List of action parameters.

Returns:

value or null for none

setParameters

public FormAction setParameters(List<ActionParameter> parameters)

List of action parameters.

Parameters:

parameters - parameters or null for none

set

public FormAction set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public FormAction clone()

Overrides:

clone in class GenericJson