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.


797
798
799
# File 'generated/google/apis/chat_v1/classes.rb', line 797

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

Instance Attribute Details

#action_responseGoogle::Apis::ChatV1::ActionResponse

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


729
730
731
# File 'generated/google/apis/chat_v1/classes.rb', line 729

def action_response
  @action_response
end

#annotationsArray<Google::Apis::ChatV1::Annotation>

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


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

def annotations
  @annotations
end

#argument_textString

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

Returns:

  • (String)

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

def argument_text
  @argument_text
end

#attachmentArray<Google::Apis::ChatV1::Attachment>

User uploaded attachment. Corresponds to the JSON property attachment


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

def attachment
  @attachment
end

#cardsArray<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:


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

def cards
  @cards
end

#create_timeString

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

Returns:

  • (String)

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

def create_time
  @create_time
end

#fallback_textString

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)

762
763
764
# File 'generated/google/apis/chat_v1/classes.rb', line 762

def fallback_text
  @fallback_text
end

#nameString

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

Returns:

  • (String)

768
769
770
# File 'generated/google/apis/chat_v1/classes.rb', line 768

def name
  @name
end

#preview_textString

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)

775
776
777
# File 'generated/google/apis/chat_v1/classes.rb', line 775

def preview_text
  @preview_text
end

#senderGoogle::Apis::ChatV1::User

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


780
781
782
# File 'generated/google/apis/chat_v1/classes.rb', line 780

def sender
  @sender
end

#spaceGoogle::Apis::ChatV1::Space

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


785
786
787
# File 'generated/google/apis/chat_v1/classes.rb', line 785

def space
  @space
end

#textString

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

Returns:

  • (String)

790
791
792
# File 'generated/google/apis/chat_v1/classes.rb', line 790

def text
  @text
end

#threadGoogle::Apis::ChatV1::Thread

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


795
796
797
# File 'generated/google/apis/chat_v1/classes.rb', line 795

def thread
  @thread
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# File 'generated/google/apis/chat_v1/classes.rb', line 802

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