Class: Google::Apis::ChatV1::CommonEventObject
- Inherits:
-
Object
- Object
- Google::Apis::ChatV1::CommonEventObject
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/chat_v1/classes.rb,
lib/google/apis/chat_v1/representations.rb,
lib/google/apis/chat_v1/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#form_inputs ⇒ Hash<String,Google::Apis::ChatV1::Inputs>
A map containing the values that a user inputs in a widget from a card or dialog.
-
#host_app ⇒ String
The hostApp enum which indicates the app the add-on is invoked from.
-
#invoked_function ⇒ String
Name of the invoked function associated with the widget.
-
#parameters ⇒ Hash<String,String>
Custom parameters passed to the invoked function.
-
#platform ⇒ String
The platform enum which indicates the platform where the event originates (
WEB
,IOS
, orANDROID
). -
#time_zone ⇒ Google::Apis::ChatV1::TimeZone
The timezone ID and offset from Coordinated Universal Time (UTC).
-
#user_locale ⇒ String
The full
locale.displayName
in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US".
Instance Method Summary collapse
-
#initialize(**args) ⇒ CommonEventObject
constructor
A new instance of CommonEventObject.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ CommonEventObject
Returns a new instance of CommonEventObject.
733 734 735 |
# File 'lib/google/apis/chat_v1/classes.rb', line 733 def initialize(**args) update!(**args) end |
Instance Attribute Details
#form_inputs ⇒ Hash<String,Google::Apis::ChatV1::Inputs>
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.
Corresponds to the JSON property formInputs
692 693 694 |
# File 'lib/google/apis/chat_v1/classes.rb', line 692 def form_inputs @form_inputs end |
#host_app ⇒ String
The hostApp enum which indicates the app the add-on is invoked from. Always
CHAT
for Chat apps.
Corresponds to the JSON property hostApp
698 699 700 |
# File 'lib/google/apis/chat_v1/classes.rb', line 698 def host_app @host_app end |
#invoked_function ⇒ String
Name of the invoked function associated with the widget. Only set for Chat
apps.
Corresponds to the JSON property invokedFunction
704 705 706 |
# File 'lib/google/apis/chat_v1/classes.rb', line 704 def invoked_function @invoked_function end |
#parameters ⇒ Hash<String,String>
Custom parameters passed
to the invoked function. Both keys and values must be strings.
Corresponds to the JSON property parameters
710 711 712 |
# File 'lib/google/apis/chat_v1/classes.rb', line 710 def parameters @parameters end |
#platform ⇒ String
The platform enum which indicates the platform where the event originates (
WEB
, IOS
, or ANDROID
). Not supported by Chat apps.
Corresponds to the JSON property platform
716 717 718 |
# File 'lib/google/apis/chat_v1/classes.rb', line 716 def platform @platform end |
#time_zone ⇒ Google::Apis::ChatV1::TimeZone
The timezone ID and offset from Coordinated Universal Time (UTC). Only
supported for the event types CARD_CLICKED
and
SUBMIT_DIALOG
.
Corresponds to the JSON property timeZone
725 726 727 |
# File 'lib/google/apis/chat_v1/classes.rb', line 725 def time_zone @time_zone end |
#user_locale ⇒ String
The full locale.displayName
in the format of [ISO 639 language code]-[ISO
3166 country/region code] such as "en-US".
Corresponds to the JSON property userLocale
731 732 733 |
# File 'lib/google/apis/chat_v1/classes.rb', line 731 def user_locale @user_locale end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
738 739 740 741 742 743 744 745 746 |
# File 'lib/google/apis/chat_v1/classes.rb', line 738 def update!(**args) @form_inputs = args[:form_inputs] if args.key?(:form_inputs) @host_app = args[:host_app] if args.key?(:host_app) @invoked_function = args[:invoked_function] if args.key?(:invoked_function) @parameters = args[:parameters] if args.key?(:parameters) @platform = args[:platform] if args.key?(:platform) @time_zone = args[:time_zone] if args.key?(:time_zone) @user_locale = args[:user_locale] if args.key?(:user_locale) end |