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.



654
655
656
 
# File 'lib/google/apis/chat_v1/classes.rb', line 654

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:



587
588
589
 
# File 'lib/google/apis/chat_v1/classes.rb', line 587

def action
  @action
end

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

Next available ID = 8 Corresponds to the JSON property common

Returns:



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

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) 


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

def config_complete_redirect_url
  @config_complete_redirect_url
end

#dialog_event_type ⇒ String

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

Returns:

  • (String) 


605
606
607
 
# File 'lib/google/apis/chat_v1/classes.rb', line 605

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) 


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

def event_time
  @event_time
end

#is_dialog_event ⇒ Boolean Also known as: is_dialog_event?

Whether or not this event is related to dialogs request, submit or cancel. This will be set to true when we want a request/submit/cancel event. Corresponds to the JSON property isDialogEvent

Returns:

  • (Boolean) 


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

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:



622
623
624
 
# File 'lib/google/apis/chat_v1/classes.rb', line 622

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:



628
629
630
 
# File 'lib/google/apis/chat_v1/classes.rb', line 628

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) 


634
635
636
 
# File 'lib/google/apis/chat_v1/classes.rb', line 634

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) 


642
643
644
 
# File 'lib/google/apis/chat_v1/classes.rb', line 642

def token
  @token
end

#type ⇒ String

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

Returns:

  • (String) 


647
648
649
 
# File 'lib/google/apis/chat_v1/classes.rb', line 647

def type
  @type
end

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

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

Returns:



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

def user
  @user
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



659
660
661
662
663
664
665
666
667
668
669
670
671
672
 
# File 'lib/google/apis/chat_v1/classes.rb', line 659

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