Class: Google::Apis::ChatV1::DeprecatedEvent

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

Google Chat events.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DeprecatedEvent

Returns a new instance of DeprecatedEvent.



664
665
666
 
# File 'lib/google/apis/chat_v1/classes.rb', line 664

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

Instance Attribute Details

#action ⇒ Google::Apis::ChatV1::FormAction

A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. Corresponds to the JSON property action

Returns:



593
594
595
 
# File 'lib/google/apis/chat_v1/classes.rb', line 593

def action
  @action
end

#common ⇒ Google::Apis::ChatV1::CommonEventObject

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. Corresponds to the JSON property common

Returns:



601
602
603
 
# File 'lib/google/apis/chat_v1/classes.rb', line 601

def common
  @common
end

#config_complete_redirect_url ⇒ String

The URL the bot should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. See the Authorizing access to 3p services guide for more information. Corresponds to the JSON property configCompleteRedirectUrl

Returns:

  • (String) 


609
610
611
 
# File 'lib/google/apis/chat_v1/classes.rb', line 609

def config_complete_redirect_url
  @config_complete_redirect_url
end

#dialog_event_type ⇒ String

The type of dialog event received. Corresponds to the JSON property dialogEventType

Returns:

  • (String) 


615
616
617
 
# File 'lib/google/apis/chat_v1/classes.rb', line 615

def dialog_event_type
  @dialog_event_type
end

#event_time ⇒ String

The timestamp indicating when the event occurred. Corresponds to the JSON property eventTime

Returns:

  • (String) 


620
621
622
 
# File 'lib/google/apis/chat_v1/classes.rb', line 620

def event_time
  @event_time
end

#is_dialog_event ⇒ Boolean Also known as: is_dialog_event?

True when the event is related to dialogs. Corresponds to the JSON property isDialogEvent

Returns:

  • (Boolean) 


626
627
628
 
# File 'lib/google/apis/chat_v1/classes.rb', line 626

def is_dialog_event
  @is_dialog_event
end

#message ⇒ Google::Apis::ChatV1::Message

A message in Google Chat. Corresponds to the JSON property message

Returns:



632
633
634
 
# File 'lib/google/apis/chat_v1/classes.rb', line 632

def message
  @message
end

#space ⇒ Google::Apis::ChatV1::Space

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. Corresponds to the JSON property space

Returns:



638
639
640
 
# File 'lib/google/apis/chat_v1/classes.rb', line 638

def space
  @space
end

#thread_key ⇒ String

The bot-defined key for the thread related to the event. See the thread_key field of the spaces.message.create request for more information. Corresponds to the JSON property threadKey

Returns:

  • (String) 


644
645
646
 
# File 'lib/google/apis/chat_v1/classes.rb', line 644

def thread_key
  @thread_key
end

#token ⇒ String

A secret value that bots can use to verify if a request is from Google. The token is randomly generated by Google, remains static, and can be obtained from the Google Chat API configuration page in the Cloud Console. Developers can revoke/regenerate it if needed from the same page. Corresponds to the JSON property token

Returns:

  • (String) 


652
653
654
 
# File 'lib/google/apis/chat_v1/classes.rb', line 652

def token
  @token
end

#type ⇒ String

The type of the event. Corresponds to the JSON property type

Returns:

  • (String) 


657
658
659
 
# File 'lib/google/apis/chat_v1/classes.rb', line 657

def type
  @type
end

#user ⇒ Google::Apis::ChatV1::User

A user in Google Chat. Corresponds to the JSON property user

Returns:



662
663
664
 
# File 'lib/google/apis/chat_v1/classes.rb', line 662

def user
  @user
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/google/apis/chat_v1/classes.rb', line 669

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @common = args[:common] if args.key?(:common)
  @config_complete_redirect_url = args[:config_complete_redirect_url] if args.key?(:config_complete_redirect_url)
  @dialog_event_type = args[:dialog_event_type] if args.key?(:dialog_event_type)
  @event_time = args[:event_time] if args.key?(:event_time)
  @is_dialog_event = args[:is_dialog_event] if args.key?(:is_dialog_event)
  @message = args[:message] if args.key?(:message)
  @space = args[:space] if args.key?(:space)
  @thread_key = args[:thread_key] if args.key?(:thread_key)
  @token = args[:token] if args.key?(:token)
  @type = args[:type] if args.key?(:type)
  @user = args[:user] if args.key?(:user)
end