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

Class DeprecatedEvent

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond- interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). Note: This event is only used for [Chat interaction events](https://developers.google.com/workspace/chat/receive-respond- interactions). If your Chat app is built as a [Google Workspace add- on](https://developers.google.com/workspace/add-ons/chat/build), see [Chat event objects](https://developers.google.com/workspace/add-ons/concepts/event-objects#chat-event- object) in the add-ons documentation.

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

Method Summary

Modifier and Type	Method and Description
DeprecatedEvent	clone()
FormAction	getAction() For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog.
AppCommandMetadata	getAppCommandMetadata() Metadata about a Chat app command.
CommonEventObject	getCommon() Represents information about the user's client, such as locale, host app, and platform.
String	getConfigCompleteRedirectUrl() This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events.
String	getDialogEventType() The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received.
String	getEventTime() The timestamp indicating when the interaction event occurred.
Boolean	getIsDialogEvent() For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is interacting with or about to interact with a [dialog](https://developers.google.com/workspace/chat/dialogs).
Message	getMessage() For `ADDED_TO_SPACE`, `CARD_CLICKED`, and `MESSAGE` interaction events, the message that triggered the interaction event, if applicable.
Space	getSpace() The space in which the user interacted with the Chat app.
Thread	getThread() The thread in which the user interacted with the Chat app.
String	getThreadKey() The Chat app-defined key for the thread related to the interaction event.
String	getToken() A secret value that legacy Chat apps can use to verify if a request is from Google.
String	getType() The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.
User	getUser() The user that interacted with the Chat app.
DeprecatedEvent	set(String fieldName, Object value)
DeprecatedEvent	setAction(FormAction action) For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog.
DeprecatedEvent	setAppCommandMetadata(AppCommandMetadata appCommandMetadata) Metadata about a Chat app command.
DeprecatedEvent	setCommon(CommonEventObject common) Represents information about the user's client, such as locale, host app, and platform.
DeprecatedEvent	setConfigCompleteRedirectUrl(String configCompleteRedirectUrl) This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events.
DeprecatedEvent	setDialogEventType(String dialogEventType) The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received.
DeprecatedEvent	setEventTime(String eventTime) The timestamp indicating when the interaction event occurred.
DeprecatedEvent	setIsDialogEvent(Boolean isDialogEvent) For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is interacting with or about to interact with a [dialog](https://developers.google.com/workspace/chat/dialogs).
DeprecatedEvent	setMessage(Message message) For `ADDED_TO_SPACE`, `CARD_CLICKED`, and `MESSAGE` interaction events, the message that triggered the interaction event, if applicable.
DeprecatedEvent	setSpace(Space space) The space in which the user interacted with the Chat app.
DeprecatedEvent	setThread(Thread thread) The thread in which the user interacted with the Chat app.
DeprecatedEvent	setThreadKey(String threadKey) The Chat app-defined key for the thread related to the interaction event.
DeprecatedEvent	setToken(String token) A secret value that legacy Chat apps can use to verify if a request is from Google.
DeprecatedEvent	setType(String type) The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.
DeprecatedEvent	setUser(User user) The user that interacted with the Chat app.

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

DeprecatedEvent

public DeprecatedEvent()

Method Detail

getAction

public FormAction getAction()

For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/workspace/chat/read-form-data).

Returns:

value or null for none

setAction

public DeprecatedEvent setAction(FormAction action)

For `CARD_CLICKED` interaction events, the form action data associated when a user clicks a card or dialog. To learn more, see [Read form data input by users on cards](https://developers.google.com/workspace/chat/read-form-data).

Parameters:

action - action or null for none

getAppCommandMetadata

public AppCommandMetadata getAppCommandMetadata()

Metadata about a Chat app command.

Returns:

value or null for none

setAppCommandMetadata

public DeprecatedEvent setAppCommandMetadata(AppCommandMetadata appCommandMetadata)

Metadata about a Chat app command.

Parameters:

appCommandMetadata - appCommandMetadata or null for none

getCommon

public CommonEventObject getCommon()

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

Returns:

value or null for none

setCommon

public DeprecatedEvent setCommon(CommonEventObject common)

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

Parameters:

common - common or null for none

getConfigCompleteRedirectUrl

public String getConfigCompleteRedirectUrl()

This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools).

Returns:

value or null for none

setConfigCompleteRedirectUrl

public DeprecatedEvent setConfigCompleteRedirectUrl(String configCompleteRedirectUrl)

This URL is populated for `MESSAGE`, `ADDED_TO_SPACE`, and `APP_COMMAND` interaction events. After completing an authorization or configuration flow outside of Google Chat, users must be redirected to this URL to signal to Google Chat that the authorization or configuration flow was successful. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools).

Parameters:

configCompleteRedirectUrl - configCompleteRedirectUrl or null for none

getDialogEventType

public String getDialogEventType()

The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received.

Returns:

value or null for none

setDialogEventType

public DeprecatedEvent setDialogEventType(String dialogEventType)

The type of [dialog](https://developers.google.com/workspace/chat/dialogs) interaction event received.

Parameters:

dialogEventType - dialogEventType or null for none

getEventTime

public String getEventTime()

The timestamp indicating when the interaction event occurred.

Returns:

value or null for none

setEventTime

public DeprecatedEvent setEventTime(String eventTime)

The timestamp indicating when the interaction event occurred.

Parameters:

eventTime - eventTime or null for none

getIsDialogEvent

public Boolean getIsDialogEvent()

For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is interacting with or about to interact with a [dialog](https://developers.google.com/workspace/chat/dialogs).

Returns:

value or null for none

setIsDialogEvent

public DeprecatedEvent setIsDialogEvent(Boolean isDialogEvent)

For `CARD_CLICKED` and `MESSAGE` interaction events, whether the user is interacting with or about to interact with a [dialog](https://developers.google.com/workspace/chat/dialogs).

Parameters:

isDialogEvent - isDialogEvent or null for none

getMessage

public Message getMessage()

For `ADDED_TO_SPACE`, `CARD_CLICKED`, and `MESSAGE` interaction events, the message that triggered the interaction event, if applicable.

Returns:

value or null for none

setMessage

public DeprecatedEvent setMessage(Message message)

For `ADDED_TO_SPACE`, `CARD_CLICKED`, and `MESSAGE` interaction events, the message that triggered the interaction event, if applicable.

Parameters:

message - message or null for none

getSpace

public Space getSpace()

The space in which the user interacted with the Chat app.

Returns:

value or null for none

setSpace

public DeprecatedEvent setSpace(Space space)

The space in which the user interacted with the Chat app.

Parameters:

space - space or null for none

getThread

public Thread getThread()

The thread in which the user interacted with the Chat app. This could be in a new thread created by a newly sent message. This field is populated if the interaction event is associated with a specific message or thread.

Returns:

value or null for none

setThread

public DeprecatedEvent setThread(Thread thread)

The thread in which the user interacted with the Chat app. This could be in a new thread created by a newly sent message. This field is populated if the interaction event is associated with a specific message or thread.

Parameters:

thread - thread or null for none

getThreadKey

public String getThreadKey()

The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages .thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.

Returns:

value or null for none

setThreadKey

public DeprecatedEvent setThreadKey(String threadKey)

The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages .thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.

Parameters:

threadKey - threadKey or null for none

getToken

public String getToken()

A secret value that legacy Chat apps can use to verify if a request is from Google. Google randomly generates the token, and its value remains static. You can obtain, revoke, or regenerate the token from the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat) in the Google Cloud Console. Modern Chat apps don't use this field. It is absent from API responses and the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat).

Returns:

value or null for none

setToken

public DeprecatedEvent setToken(String token)

A secret value that legacy Chat apps can use to verify if a request is from Google. Google randomly generates the token, and its value remains static. You can obtain, revoke, or regenerate the token from the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat) in the Google Cloud Console. Modern Chat apps don't use this field. It is absent from API responses and the [Chat API configuration page](https://console.cloud.google.com/apis/api/chat.googleapis.com/hangouts-chat).

Parameters:

token - token or null for none

getType

public String getType()

The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.

Returns:

value or null for none

setType

public DeprecatedEvent setType(String type)

The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.

Parameters:

type - type or null for none

getUser

public User getUser()

The user that interacted with the Chat app.

Returns:

value or null for none

setUser

public DeprecatedEvent setUser(User user)

The user that interacted with the Chat app.

Parameters:

user - user or null for none

set

public DeprecatedEvent set(String fieldName,
                           Object value)

Overrides:

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

clone

public DeprecatedEvent clone()

Overrides:

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