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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/chat_v1/classes.rb,
generated/google/apis/chat_v1/representations.rb,
generated/google/apis/chat_v1/representations.rb

Overview

A message in Hangouts Chat.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.



691
692
693
 
# File 'generated/google/apis/chat_v1/classes.rb', line 691

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:



627
628
629
 
# File 'generated/google/apis/chat_v1/classes.rb', line 627

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:



632
633
634
 
# File 'generated/google/apis/chat_v1/classes.rb', line 632

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) 


637
638
639
 
# File 'generated/google/apis/chat_v1/classes.rb', line 637

def argument_text
  @argument_text
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:



644
645
646
 
# File 'generated/google/apis/chat_v1/classes.rb', line 644

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) 


650
651
652
 
# File 'generated/google/apis/chat_v1/classes.rb', line 650

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) 


656
657
658
 
# File 'generated/google/apis/chat_v1/classes.rb', line 656

def fallback_text
  @fallback_text
end

#name ⇒ String

Resource name, in the form "spaces//messages/". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 Corresponds to the JSON property name

Returns:

  • (String) 


662
663
664
 
# File 'generated/google/apis/chat_v1/classes.rb', line 662

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) 


669
670
671
 
# File 'generated/google/apis/chat_v1/classes.rb', line 669

def preview_text
  @preview_text
end

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

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

Returns:



674
675
676
 
# File 'generated/google/apis/chat_v1/classes.rb', line 674

def sender
  @sender
end

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

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

Returns:



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

def space
  @space
end

#text ⇒ String

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

Returns:

  • (String) 


684
685
686
 
# File 'generated/google/apis/chat_v1/classes.rb', line 684

def text
  @text
end

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

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

Returns:



689
690
691
 
# File 'generated/google/apis/chat_v1/classes.rb', line 689

def thread
  @thread
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# File 'generated/google/apis/chat_v1/classes.rb', line 696

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)
  @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)
  @space = args[:space] if args.key?(:space)
  @text = args[:text] if args.key?(:text)
  @thread = args[:thread] if args.key?(:thread)
end