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.



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

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:



679
680
681
 
# File 'lib/google/apis/chat_v1/classes.rb', line 679

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:



687
688
689
 
# File 'lib/google/apis/chat_v1/classes.rb', line 687

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. See the Authorizing access to 3p services guide for more information. Corresponds to the JSON property configCompleteRedirectUrl

Returns:

  • (String) 


695
696
697
 
# File 'lib/google/apis/chat_v1/classes.rb', line 695

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) 


701
702
703
 
# File 'lib/google/apis/chat_v1/classes.rb', line 701

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) 


706
707
708
 
# File 'lib/google/apis/chat_v1/classes.rb', line 706

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) 


712
713
714
 
# File 'lib/google/apis/chat_v1/classes.rb', line 712

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:



718
719
720
 
# File 'lib/google/apis/chat_v1/classes.rb', line 718

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:



724
725
726
 
# File 'lib/google/apis/chat_v1/classes.rb', line 724

def space
  @space
end

#thread_key ⇒ String

The Chat app-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) 


730
731
732
 
# File 'lib/google/apis/chat_v1/classes.rb', line 730

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) 


741
742
743
 
# File 'lib/google/apis/chat_v1/classes.rb', line 741

def token
  @token
end

#type ⇒ String

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

Returns:

  • (String) 


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

def type
  @type
end

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

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

Returns:



751
752
753
 
# File 'lib/google/apis/chat_v1/classes.rb', line 751

def user
  @user
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/google/apis/chat_v1/classes.rb', line 758

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