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

Class CommonEventObject

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CommonEventObject
extends com.google.api.client.json.GenericJson

Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes data submitted by users interacting with cards, like data entered in [dialogs](https://developers.google.com/chat/how-tos/dialogs).

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

Method Summary

Modifier and Type	Method and Description
CommonEventObject	clone()
Map<String,Inputs>	getFormInputs() A map containing the current values of the widgets in a card.
String	getHostApp() The hostApp enum which indicates the app the add-on is invoked from.
String	getInvokedFunction() Name of the invoked function associated with the widget.
Map<String,String>	getParameters() Custom [parameters](/chat/api/reference/rest/v1/cards#ActionParameter) passed to the invoked function.
String	getPlatform() The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`).
TimeZone	getTimeZone() The timezone ID and offset from Coordinated Universal Time (UTC).
String	getUserLocale() The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US".
CommonEventObject	set(String fieldName, Object value)
CommonEventObject	setFormInputs(Map<String,Inputs> formInputs) A map containing the current values of the widgets in a card.
CommonEventObject	setHostApp(String hostApp) The hostApp enum which indicates the app the add-on is invoked from.
CommonEventObject	setInvokedFunction(String invokedFunction) Name of the invoked function associated with the widget.
CommonEventObject	setParameters(Map<String,String> parameters) Custom [parameters](/chat/api/reference/rest/v1/cards#ActionParameter) passed to the invoked function.
CommonEventObject	setPlatform(String platform) The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`).
CommonEventObject	setTimeZone(TimeZone timeZone) The timezone ID and offset from Coordinated Universal Time (UTC).
CommonEventObject	setUserLocale(String userLocale) The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US".

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

CommonEventObject

public CommonEventObject()

Method Detail

getFormInputs

public Map<String,Inputs> getFormInputs()

A map containing the current values of the widgets in a card. The map keys are the string IDs assigned to each widget, and the values represent inputs to the widget. Depending on the input data type, a different object represents each input: For single-value widgets, `StringInput`. For multi-value widgets, an array of `StringInput` objects. For a date-time picker, a `DateTimeInput`. For a date-only picker, a `DateInput`. For a time-only picker, a `TimeInput`. Corresponds with the data entered by a user on a card in a [dialog](https://developers.google.com/chat/how-tos/dialogs).

Returns:

value or null for none

setFormInputs

public CommonEventObject setFormInputs(Map<String,Inputs> formInputs)

A map containing the current values of the widgets in a card. The map keys are the string IDs assigned to each widget, and the values represent inputs to the widget. Depending on the input data type, a different object represents each input: For single-value widgets, `StringInput`. For multi-value widgets, an array of `StringInput` objects. For a date-time picker, a `DateTimeInput`. For a date-only picker, a `DateInput`. For a time-only picker, a `TimeInput`. Corresponds with the data entered by a user on a card in a [dialog](https://developers.google.com/chat/how-tos/dialogs).

Parameters:

formInputs - formInputs or null for none

getHostApp

public String getHostApp()

The hostApp enum which indicates the app the add-on is invoked from. Always `CHAT` for Chat apps.

Returns:

value or null for none

setHostApp

public CommonEventObject setHostApp(String hostApp)

The hostApp enum which indicates the app the add-on is invoked from. Always `CHAT` for Chat apps.

Parameters:

hostApp - hostApp or null for none

getInvokedFunction

public String getInvokedFunction()

Name of the invoked function associated with the widget. Only set for Chat apps.

Returns:

value or null for none

setInvokedFunction

public CommonEventObject setInvokedFunction(String invokedFunction)

Name of the invoked function associated with the widget. Only set for Chat apps.

Parameters:

invokedFunction - invokedFunction or null for none

getParameters

public Map<String,String> getParameters()

Custom [parameters](/chat/api/reference/rest/v1/cards#ActionParameter) passed to the invoked function. Both keys and values must be strings.

Returns:

value or null for none

setParameters

public CommonEventObject setParameters(Map<String,String> parameters)

Custom [parameters](/chat/api/reference/rest/v1/cards#ActionParameter) passed to the invoked function. Both keys and values must be strings.

Parameters:

parameters - parameters or null for none

getPlatform

public String getPlatform()

The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps.

Returns:

value or null for none

setPlatform

public CommonEventObject setPlatform(String platform)

The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps.

Parameters:

platform - platform or null for none

getTimeZone

public TimeZone getTimeZone()

The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_ VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/res t/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).

Returns:

value or null for none

setTimeZone

public CommonEventObject setTimeZone(TimeZone timeZone)

The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_ VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/res t/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG).

Parameters:

timeZone - timeZone or null for none

getUserLocale

public String getUserLocale()

The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US".

Returns:

value or null for none

setUserLocale

public CommonEventObject setUserLocale(String userLocale)

The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US".

Parameters:

userLocale - userLocale or null for none

set

public CommonEventObject set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public CommonEventObject clone()

Overrides:

clone in class com.google.api.client.json.GenericJson