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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.



3977
3978
3979
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3977

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

Instance Attribute Details

#accessory_widgets ⇒ Array<Google::Apis::ChatV1::AccessoryWidget>

One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see Add interactive widgets at the bottom of a message. Creating a message with accessory widgets requires app authentication. Corresponds to the JSON property accessoryWidgets

Returns:



3782
3783
3784
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3782

def accessory_widgets
  @accessory_widgets
end

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

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

Returns:



3787
3788
3789
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3787

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:



3792
3793
3794
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3792

def annotations
  @annotations
end

#argument_text ⇒ String

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

Returns:

  • (String) 


3798
3799
3800
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3798

def argument_text
  @argument_text
end

#attached_gifs ⇒ Array<Google::Apis::ChatV1::AttachedGif>

Output only. GIF images that are attached to the message. Corresponds to the JSON property attachedGifs

Returns:



3803
3804
3805
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3803

def attached_gifs
  @attached_gifs
end

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

User-uploaded attachment. Corresponds to the JSON property attachment

Returns:



3808
3809
3810
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3808

def attachment
  @attachment
end

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

Deprecated: Use cards_v2 instead. Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB. Corresponds to the JSON property cards

Returns:



3816
3817
3818
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3816

def cards
  @cards
end

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

An array of cards. Only Chat apps can create cards. If your Chat app authenticates as a user, the messages can't contain cards. To learn about cards and how to create them, see Send card messages. Card builder Corresponds to the JSON property cardsV2

Returns:



3827
3828
3829
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3827

def cards_v2
  @cards_v2
end

#client_assigned_message_id ⇒ String

Optional. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the messageId field when you create the message. For details, see Name a message. Corresponds to the JSON property clientAssignedMessageId

Returns:

  • (String) 


3837
3838
3839
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3837

def client_assigned_message_id
  @client_assigned_message_id
end

#create_time ⇒ String

Optional. Immutable. For spaces created in Chat, the time at which the message was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


3846
3847
3848
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3846

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


3852
3853
3854
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3852

def delete_time
  @delete_time
end

#deletion_metadata ⇒ Google::Apis::ChatV1::DeletionMetadata

Information about a deleted message. A message is deleted when delete_time is set. Corresponds to the JSON property deletionMetadata

Returns:



3858
3859
3860
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3858

def deletion_metadata
  @deletion_metadata
end

#emoji_reaction_summaries ⇒ Array<Google::Apis::ChatV1::EmojiReactionSummary>

Output only. The list of emoji reaction summaries on the message. Corresponds to the JSON property emojiReactionSummaries

Returns:



3863
3864
3865
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3863

def emoji_reaction_summaries
  @emoji_reaction_summaries
end

#fallback_text ⇒ String

A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. Corresponds to the JSON property fallbackText

Returns:

  • (String) 


3869
3870
3871
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3869

def fallback_text
  @fallback_text
end

#formatted_text ⇒ String

Output only. Contains the message text with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * Markup syntax for bold, italic, strikethrough, monospace, monospace block, and bulleted list. * User mentions using the format . * Custom hyperlinks using the format <url|rendered_text> where the first string is the URL and the second is the rendered text—for example, `. * Custom emoji using the format:emoji_name:—for example,:smile:. This doesn't apply to Unicode emoji, such asU+1F600for a grinning face emoji. For more information, see [View text formatting sent in a message](https:// developers.google.com/workspace/chat/format-messages# view_text_formatting_sent_in_a_message) Corresponds to the JSON propertyformattedText`

Returns:

  • (String) 


3886
3887
3888
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3886

def formatted_text
  @formatted_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) 


3892
3893
3894
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3892

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, see Preview links. Corresponds to the JSON property matchedUrl

Returns:



3899
3900
3901
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3899

def matched_url
  @matched_url
end

#name ⇒ String

Resource name of the message. Format: spaces/space/messages/message Wherespaceis the ID of the space where the message is posted and messageis a system-assigned ID for the message. For example, `spaces/ AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacingmessage`with the value from theclientAssignedMessageIdfield. For example,spaces/AAAAAAAAAAA/messages/client-custom-name. For details, see [Name a message](https://developers.google.com/workspace/chat/create- messages#name_a_created_message). Corresponds to the JSON propertyname`

Returns:

  • (String) 


3912
3913
3914
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3912

def name
  @name
end

#private_message_viewer ⇒ Google::Apis::ChatV1::User

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user, the output for a User resource only populates the user's name and type. Corresponds to the JSON property privateMessageViewer

Returns:



3920
3921
3922
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3920

def private_message_viewer
  @private_message_viewer
end

#quoted_message_metadata ⇒ Google::Apis::ChatV1::QuotedMessageMetadata

Information about a quoted message. Corresponds to the JSON property quotedMessageMetadata

Returns:



3925
3926
3927
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3925

def quoted_message_metadata
  @quoted_message_metadata
end

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

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user, the output for a User resource only populates the user's name and type. Corresponds to the JSON property sender

Returns:



3933
3934
3935
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3933

def sender
  @sender
end

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

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

Returns:



3939
3940
3941
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3939

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:



3945
3946
3947
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3945

def space
  @space
end

#text ⇒ String

Plain-text body of the message. The first link to an image, video, or web page generates a preview chip. You can also @mention a Google Chat user, or everyone in the space. To learn about creating text messages, see Send a text message. Corresponds to the JSON property text

Returns:

  • (String) 


3956
3957
3958
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3956

def text
  @text
end

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

A thread in a Google Chat space. For example usage, see Start or reply to a message thread. If you specify a thread when creating a message, you can set the messageReplyOption field to determine what happens if no matching thread is found. Corresponds to the JSON property thread

Returns:



3966
3967
3968
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3966

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) 


3974
3975
3976
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3974

def thread_reply
  @thread_reply
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3982

def update!(**args)
  @accessory_widgets = args[:accessory_widgets] if args.key?(:accessory_widgets)
  @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)
  @attached_gifs = args[:attached_gifs] if args.key?(:attached_gifs)
  @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)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @deletion_metadata = args[:deletion_metadata] if args.key?(:deletion_metadata)
  @emoji_reaction_summaries = args[:emoji_reaction_summaries] if args.key?(:emoji_reaction_summaries)
  @fallback_text = args[:fallback_text] if args.key?(:fallback_text)
  @formatted_text = args[:formatted_text] if args.key?(:formatted_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)
  @private_message_viewer = args[:private_message_viewer] if args.key?(:private_message_viewer)
  @quoted_message_metadata = args[:quoted_message_metadata] if args.key?(:quoted_message_metadata)
  @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