Class: Google::Apis::ChatV1::CommonEventObject

Inherits:
Object
  • Object
show all
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

Next available ID = 8

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CommonEventObject

Returns a new instance of CommonEventObject.



511
512
513
 
# File 'lib/google/apis/chat_v1/classes.rb', line 511

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#form_inputs ⇒ Hash<String,Google::Apis::ChatV1::Inputs>

The keys are the string IDs associated with the widget and the values are inputs with a widget in the card. Corresponds to the JSON property formInputs

Returns:



475
476
477
 
# File 'lib/google/apis/chat_v1/classes.rb', line 475

def form_inputs
  @form_inputs
end

#host_app ⇒ String

The hostApp enum which indicates the app the add-on is invoked from Corresponds to the JSON property hostApp

Returns:

  • (String) 


480
481
482
 
# File 'lib/google/apis/chat_v1/classes.rb', line 480

def host_app
  @host_app
end

#invoked_function ⇒ String

Name of the invoked function associated with the widget. This field is currently only set for chat. Corresponds to the JSON property invokedFunction

Returns:

  • (String) 


486
487
488
 
# File 'lib/google/apis/chat_v1/classes.rb', line 486

def invoked_function
  @invoked_function
end

#parameters ⇒ Hash<String,String>

Any additional parameters. Corresponds to the JSON property parameters

Returns:

  • (Hash<String,String>) 


491
492
493
 
# File 'lib/google/apis/chat_v1/classes.rb', line 491

def parameters
  @parameters
end

#platform ⇒ String

The platform enum which indicates the platform where the add-on is running. Corresponds to the JSON property platform

Returns:

  • (String) 


496
497
498
 
# File 'lib/google/apis/chat_v1/classes.rb', line 496

def platform
  @platform
end

#time_zone ⇒ Google::Apis::ChatV1::TimeZone

The timezone id and offset. The id is the tz database time zones such as " America/Toronto". The user timezone offset, in milliseconds, from Coordinated Universal Time (UTC). Corresponds to the JSON property timeZone

Returns:



503
504
505
 
# File 'lib/google/apis/chat_v1/classes.rb', line 503

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

Returns:

  • (String) 


509
510
511
 
# File 'lib/google/apis/chat_v1/classes.rb', line 509

def user_locale
  @user_locale
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



516
517
518
519
520
521
522
523
524
 
# File 'lib/google/apis/chat_v1/classes.rb', line 516

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