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 Google Chat.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.



2848
2849
2850
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2848

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

Instance Attribute Details

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

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

Returns:



2735
2736
2737
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2735

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:



2740
2741
2742
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2740

def annotations
  @annotations
end

#argument_text ⇒ String

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

Returns:

  • (String) 


2745
2746
2747
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2745

def argument_text
  @argument_text
end

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

User uploaded attachment. Corresponds to the JSON property attachment

Returns:



2750
2751
2752
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2750

def attachment
  @attachment
end

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

Deprecated: Use cards_v2 instead. 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:



2758
2759
2760
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2758

def cards
  @cards
end

#cards_v2 ⇒ Array<Google::Apis::ChatV1::CardWithId>

Richly formatted and interactive cards that display UI elements and editable widgets, such as: - Formatted text - Buttons - Clickable images - Checkboxes - Radio buttons - Input widgets. Cards are usually displayed below the text-body of a Chat message, but can situationally appear other places, such as dialogs. The cardId is a unique identifier among cards in the same message and for identifying user input values. Currently supported widgets include: - TextParagraph - DecoratedText - Image - ButtonList - Divider Corresponds to the JSON property cardsV2

Returns:



2770
2771
2772
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2770

def cards_v2
  @cards_v2
end

#client_assigned_message_id ⇒ String

A custom name for a Chat message assigned at creation. Must start with client- and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this field to get, update, or delete the message with the specified value. For example usage, see Name a created message. Corresponds to the JSON property clientAssignedMessageId

Returns:

  • (String) 


2779
2780
2781
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2779

def client_assigned_message_id
  @client_assigned_message_id
end

#create_time ⇒ String

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

Returns:

  • (String) 


2784
2785
2786
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2784

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) 


2790
2791
2792
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2790

def fallback_text
  @fallback_text
end

#last_update_time ⇒ String

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. Corresponds to the JSON property lastUpdateTime

Returns:

  • (String) 


2796
2797
2798
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2796

def last_update_time
  @last_update_time
end

#matched_url ⇒ Google::Apis::ChatV1::MatchedUrl

A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to Preview links. Corresponds to the JSON property matchedUrl

Returns:



2803
2804
2805
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2803

def matched_url
  @matched_url
end

#name ⇒ String

Resource name in the form spaces/*/messages/*. Example: spaces/AAAAAAAAAAA/ messages/BBBBBBBBBBB.BBBBBBBBBBB Corresponds to the JSON property name

Returns:

  • (String) 


2809
2810
2811
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2809

def name
  @name
end

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

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

Returns:



2814
2815
2816
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2814

def sender
  @sender
end

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

A slash command in Google Chat. Corresponds to the JSON property slashCommand

Returns:



2820
2821
2822
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2820

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



2826
2827
2828
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2826

def space
  @space
end

#text ⇒ String

Plain-text body of the message. The first link to an image, video, web page, or other preview-able item generates a preview chip. Corresponds to the JSON property text

Returns:

  • (String) 


2832
2833
2834
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2832

def text
  @text
end

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

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

Returns:



2837
2838
2839
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2837

def thread
  @thread
end

#thread_reply ⇒ Boolean Also known as: thread_reply?

Output only. When true, the message is a response in a reply thread. When false, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always false. Corresponds to the JSON property threadReply

Returns:

  • (Boolean) 


2845
2846
2847
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2845

def thread_reply
  @thread_reply
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2853

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)
  @cards_v2 = args[:cards_v2] if args.key?(:cards_v2)
  @client_assigned_message_id = args[:client_assigned_message_id] if args.key?(:client_assigned_message_id)
  @create_time = args[:create_time] if args.key?(:create_time)
  @fallback_text = args[:fallback_text] if args.key?(:fallback_text)
  @last_update_time = args[:last_update_time] if args.key?(:last_update_time)
  @matched_url = args[:matched_url] if args.key?(:matched_url)
  @name = args[:name] if args.key?(:name)
  @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)
  @thread_reply = args[:thread_reply] if args.key?(:thread_reply)
end