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

A Google Chat app interaction event. To learn about interaction events, see Receive and respond to interactions with your Google Chat app. To learn about event types and for example event payloads, see Types of Google Chat app interaction events. In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see Work with events from Google Chat.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DeprecatedEvent

Returns a new instance of DeprecatedEvent.



969
970
971
 
# File 'lib/google/apis/chat_v1/classes.rb', line 969

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:



889
890
891
 
# File 'lib/google/apis/chat_v1/classes.rb', line 889

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:



897
898
899
 
# File 'lib/google/apis/chat_v1/classes.rb', line 897

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) 


905
906
907
 
# File 'lib/google/apis/chat_v1/classes.rb', line 905

def config_complete_redirect_url
  @config_complete_redirect_url
end

#dialog_event_type ⇒ String

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

Returns:

  • (String) 


911
912
913
 
# File 'lib/google/apis/chat_v1/classes.rb', line 911

def dialog_event_type
  @dialog_event_type
end

#event_time ⇒ String

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

Returns:

  • (String) 


916
917
918
 
# File 'lib/google/apis/chat_v1/classes.rb', line 916

def event_time
  @event_time
end

#is_dialog_event ⇒ Boolean Also known as: is_dialog_event?

For CARD_CLICKED and MESSAGE interaction events, whether the user is interacting with or about to interact with a dialog. Corresponds to the JSON property isDialogEvent

Returns:

  • (Boolean) 


923
924
925
 
# File 'lib/google/apis/chat_v1/classes.rb', line 923

def is_dialog_event
  @is_dialog_event
end

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

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

Returns:



929
930
931
 
# File 'lib/google/apis/chat_v1/classes.rb', line 929

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:



935
936
937
 
# File 'lib/google/apis/chat_v1/classes.rb', line 935

def space
  @space
end

#thread_key ⇒ String

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

Returns:

  • (String) 


942
943
944
 
# File 'lib/google/apis/chat_v1/classes.rb', line 942

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) 


953
954
955
 
# File 'lib/google/apis/chat_v1/classes.rb', line 953

def token
  @token
end

#type ⇒ String

The type of interaction event. For details, see Types of Google Chat app interaction events. Corresponds to the JSON property type

Returns:

  • (String) 


959
960
961
 
# File 'lib/google/apis/chat_v1/classes.rb', line 959

def type
  @type
end

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

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user, the output for a User resource only populates the user's name and type. Corresponds to the JSON property user

Returns:



967
968
969
 
# File 'lib/google/apis/chat_v1/classes.rb', line 967

def user
  @user
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



974
975
976
977
978
979
980
981
982
983
984
985
986
987
 
# File 'lib/google/apis/chat_v1/classes.rb', line 974

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