Class: Google::Apis::ChatV1::Message

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 message in Hangouts Chat.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.



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

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

Instance Attribute Details

#action_response ⇒ Google::Apis::ChatV1::ActionResponse

Parameters that a bot can use to configure how it's response is posted. Corresponds to the JSON property actionResponse

Returns:



734
735
736
 
# File 'lib/google/apis/chat_v1/classes.rb', line 734

def action_response
  @action_response
end

#annotations ⇒ Array<Google::Apis::ChatV1::Annotation>

Output only. Annotations associated with the text in this message. Corresponds to the JSON property annotations

Returns:



739
740
741
 
# File 'lib/google/apis/chat_v1/classes.rb', line 739

def annotations
  @annotations
end

#argument_text ⇒ String

Plain-text body of the message with all bot mentions stripped out. Corresponds to the JSON property argumentText

Returns:

  • (String) 


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

def argument_text
  @argument_text
end

#attachment ⇒ Array<Google::Apis::ChatV1::Attachment>

User uploaded attachment. Corresponds to the JSON property attachment

Returns:



749
750
751
 
# File 'lib/google/apis/chat_v1/classes.rb', line 749

def attachment
  @attachment
end

#cards ⇒ Array<Google::Apis::ChatV1::Card>

Rich, formatted and interactive cards that can be used to display UI elements such as: formatted texts, buttons, clickable images. Cards are normally displayed below the plain-text body of the message. Corresponds to the JSON property cards

Returns:



756
757
758
 
# File 'lib/google/apis/chat_v1/classes.rb', line 756

def cards
  @cards
end

#create_time ⇒ String

Output only. The time at which the message was created in Hangouts Chat server. Corresponds to the JSON property createTime

Returns:

  • (String) 


761
762
763
 
# File 'lib/google/apis/chat_v1/classes.rb', line 761

def create_time
  @create_time
end

#fallback_text ⇒ String

A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). Corresponds to the JSON property fallbackText

Returns:

  • (String) 


767
768
769
 
# File 'lib/google/apis/chat_v1/classes.rb', line 767

def fallback_text
  @fallback_text
end

#name ⇒ String

Corresponds to the JSON property name

Returns:

  • (String) 


772
773
774
 
# File 'lib/google/apis/chat_v1/classes.rb', line 772

def name
  @name
end

#preview_text ⇒ String

Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. Corresponds to the JSON property previewText

Returns:

  • (String) 


779
780
781
 
# File 'lib/google/apis/chat_v1/classes.rb', line 779

def preview_text
  @preview_text
end

#sender ⇒ Google::Apis::ChatV1::User

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

Returns:



784
785
786
 
# File 'lib/google/apis/chat_v1/classes.rb', line 784

def sender
  @sender
end

#slash_command ⇒ Google::Apis::ChatV1::SlashCommand

A Slash Command in Chat. Corresponds to the JSON property slashCommand

Returns:



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

def slash_command
  @slash_command
end

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

A room or DM in Hangouts Chat. Corresponds to the JSON property space

Returns:



794
795
796
 
# File 'lib/google/apis/chat_v1/classes.rb', line 794

def space
  @space
end

#text ⇒ String

Plain-text body of the message. Corresponds to the JSON property text

Returns:

  • (String) 


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

def text
  @text
end

#thread ⇒ Google::Apis::ChatV1::Thread

A thread in Hangouts Chat. Corresponds to the JSON property thread

Returns:



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

def thread
  @thread
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/apis/chat_v1/classes.rb', line 811

def update!(**args)
  @action_response = args[:action_response] if args.key?(:action_response)
  @annotations = args[:annotations] if args.key?(:annotations)
  @argument_text = args[:argument_text] if args.key?(:argument_text)
  @attachment = args[:attachment] if args.key?(:attachment)
  @cards = args[:cards] if args.key?(:cards)
  @create_time = args[:create_time] if args.key?(:create_time)
  @fallback_text = args[:fallback_text] if args.key?(:fallback_text)
  @name = args[:name] if args.key?(:name)
  @preview_text = args[:preview_text] if args.key?(:preview_text)
  @sender = args[:sender] if args.key?(:sender)
  @slash_command = args[:slash_command] if args.key?(:slash_command)
  @space = args[:space] if args.key?(:space)
  @text = args[:text] if args.key?(:text)
  @thread = args[:thread] if args.key?(:thread)
end