View Source GoogleApi.Chat.V1.Model.DeprecatedEvent (google_api_chat v0.36.1)
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. 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.
Attributes
-
action
(type:GoogleApi.Chat.V1.Model.FormAction.t
, default:nil
) - ForCARD_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. -
common
(type:GoogleApi.Chat.V1.Model.CommonEventObject.t
, default:nil
) - 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, like data entered on a card. -
configCompleteRedirectUrl
(type:String.t
, default:nil
) - The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see Connect a Chat app with other services & tools. -
dialogEventType
(type:String.t
, default:nil
) - The type of dialog interaction event received. -
eventTime
(type:DateTime.t
, default:nil
) - The timestamp indicating when the interaction event occurred. -
isDialogEvent
(type:boolean()
, default:nil
) - ForCARD_CLICKED
andMESSAGE
interaction events, whether the user is interacting with or about to interact with a dialog. -
message
(type:GoogleApi.Chat.V1.Model.Message.t
, default:nil
) - ForADDED_TO_SPACE
,CARD_CLICKED
, andMESSAGE
interaction events, the message that triggered the interaction event, if applicable. -
space
(type:GoogleApi.Chat.V1.Model.Space.t
, default:nil
) - The space in which the user interacted with the Chat app. -
threadKey
(type:String.t
, default:nil
) - The Chat app-defined key for the thread related to the interaction event. Seespaces.messages.thread.threadKey
for more information. -
token
(type:String.t
, default:nil
) - 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 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. -
type
(type:String.t
, default:nil
) - The type of user interaction with the Chat app, such asMESSAGE
orADDED_TO_SPACE
. -
user
(type:GoogleApi.Chat.V1.Model.User.t
, default:nil
) - The user that interacted with the Chat app.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Chat.V1.Model.DeprecatedEvent{ action: GoogleApi.Chat.V1.Model.FormAction.t() | nil, common: GoogleApi.Chat.V1.Model.CommonEventObject.t() | nil, configCompleteRedirectUrl: String.t() | nil, dialogEventType: String.t() | nil, eventTime: DateTime.t() | nil, isDialogEvent: boolean() | nil, message: GoogleApi.Chat.V1.Model.Message.t() | nil, space: GoogleApi.Chat.V1.Model.Space.t() | nil, threadKey: String.t() | nil, token: String.t() | nil, type: String.t() | nil, user: GoogleApi.Chat.V1.Model.User.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.