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. To learn how to use events, see Receive and respond to Google Chat events.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DeprecatedEvent

Returns a new instance of DeprecatedEvent.



812
813
814
 
# File 'lib/google/apis/chat_v1/classes.rb', line 812

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, you can invoke Apps Script to handle the form. Corresponds to the JSON property action

Returns:



737
738
739
 
# File 'lib/google/apis/chat_v1/classes.rb', line 737

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:



745
746
747
 
# File 'lib/google/apis/chat_v1/classes.rb', line 745

def common
  @common
end

#config_complete_redirect_url ⇒ String

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

Returns:

  • (String) 


753
754
755
 
# File 'lib/google/apis/chat_v1/classes.rb', line 753

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) 


759
760
761
 
# File 'lib/google/apis/chat_v1/classes.rb', line 759

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) 


764
765
766
 
# File 'lib/google/apis/chat_v1/classes.rb', line 764

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) 


770
771
772
 
# File 'lib/google/apis/chat_v1/classes.rb', line 770

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:



776
777
778
 
# File 'lib/google/apis/chat_v1/classes.rb', line 776

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

Returns:



782
783
784
 
# File 'lib/google/apis/chat_v1/classes.rb', line 782

def space
  @space
end

#thread_key ⇒ String

The Chat app-defined key for the thread related to the event. See spaces. messages.thread.threadKey for more information. Corresponds to the JSON property threadKey

Returns:

  • (String) 


789
790
791
 
# File 'lib/google/apis/chat_v1/classes.rb', line 789

def thread_key
  @thread_key
end

#token ⇒ String

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

Returns:

  • (String) 


800
801
802
 
# File 'lib/google/apis/chat_v1/classes.rb', line 800

def token
  @token
end

#type ⇒ String

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

Returns:

  • (String) 


805
806
807
 
# File 'lib/google/apis/chat_v1/classes.rb', line 805

def type
  @type
end

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

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

Returns:



810
811
812
 
# File 'lib/google/apis/chat_v1/classes.rb', line 810

def user
  @user
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/google/apis/chat_v1/classes.rb', line 817

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