View Source GoogleApi.Chat.V1.Model.CommonEventObject (google_api_chat v0.34.3)
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.
Attributes
-
formInputs
(type:%{optional(String.t) => GoogleApi.Chat.V1.Model.Inputs.t}
, default:nil
) - A map containing the values that a user inputs in a widget from a card or dialog. The map keys are the string IDs assigned to each widget, and the values represent inputs to the widget. For details, see Process information inputted by users. -
hostApp
(type:String.t
, default:nil
) - The hostApp enum which indicates the app the add-on is invoked from. AlwaysCHAT
for Chat apps. -
invokedFunction
(type:String.t
, default:nil
) - Name of the invoked function associated with the widget. Only set for Chat apps. -
parameters
(type:map()
, default:nil
) - Custom parameters passed to the invoked function. Both keys and values must be strings. -
platform
(type:String.t
, default:nil
) - The platform enum which indicates the platform where the event originates (WEB
,IOS
, orANDROID
). Not supported by Chat apps. -
timeZone
(type:GoogleApi.Chat.V1.Model.TimeZone.t
, default:nil
) - The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event typesCARD_CLICKED
andSUBMIT_DIALOG
. -
userLocale
(type:String.t
, default:nil
) - The fulllocale.displayName
in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US".
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Chat.V1.Model.CommonEventObject{ formInputs: %{optional(String.t()) => GoogleApi.Chat.V1.Model.Inputs.t()} | nil, hostApp: String.t() | nil, invokedFunction: String.t() | nil, parameters: map() | nil, platform: String.t() | nil, timeZone: GoogleApi.Chat.V1.Model.TimeZone.t() | nil, userLocale: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.