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.



5570
5571
5572
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5570

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

Instance Attribute Details

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

Optional. 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:



5359
5360
5361
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5359

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:



5364
5365
5366
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5364

def action_response
  @action_response
end

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

Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with start_index and length of 0. Corresponds to the JSON property annotations

Returns:



5371
5372
5373
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5371

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) 


5377
5378
5379
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5377

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:



5382
5383
5384
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5382

def attached_gifs
  @attached_gifs
end

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

Optional. User-uploaded attachment. Corresponds to the JSON property attachment

Returns:



5387
5388
5389
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5387

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:



5395
5396
5397
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5395

def cards
  @cards
end

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

Optional. An array of cards. Chat apps can create cards with app authentication. As part of the Developer Preview Program, if your Chat app authenticates as a user, it can create card messages. If your Chat app is not part of Developer Preview Program, it can't create cards with user authentication. To learn how to create a message that contains cards, see Send a message. Card builder Corresponds to the JSON property cardsV2

Returns:



5410
5411
5412
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5410

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) 


5420
5421
5422
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5420

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) 


5429
5430
5431
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5429

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) 


5435
5436
5437
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5435

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:



5441
5442
5443
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5441

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:



5446
5447
5448
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5446

def emoji_reaction_summaries
  @emoji_reaction_summaries
end

#fallback_text ⇒ String

Optional. 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) 


5452
5453
5454
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5452

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, bulleted list, and block quote. * 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 as U+1F600 for a grinning face emoji. * Bullet list items using asterisks (*)—for example, * item. For more information, see View text formatting sent in a message Corresponds to the JSON property formattedText

Returns:

  • (String) 


5470
5471
5472
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5470

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) 


5476
5477
5478
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5476

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:



5483
5484
5485
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5483

def matched_url
  @matched_url
end

#name ⇒ String

Identifier. Resource name of the message. Format: spaces/space/messages/ messageWherespaceis the ID of the space where the message is posted andmessageis 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) 


5496
5497
5498
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5496

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:



5504
5505
5506
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5504

def private_message_viewer
  @private_message_viewer
end

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

Information about a message that another message quotes. When you update a message, you can't add or replace the quotedMessageMetadata field, but you can remove it. For example usage, see Quote another message. Corresponds to the JSON property quotedMessageMetadata

Returns:



5512
5513
5514
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5512

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:



5520
5521
5522
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5520

def sender
  @sender
end

#silent ⇒ Boolean Also known as: silent?

Output only. Whether this is a silent message. Silent messages are messages where Chat suppresses push notifications for recipients. Corresponds to the JSON property silent

Returns:

  • (Boolean) 


5526
5527
5528
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5526

def silent
  @silent
end

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

Metadata about a slash command in Google Chat. Corresponds to the JSON property slashCommand

Returns:



5533
5534
5535
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5533

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:



5539
5540
5541
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5539

def space
  @space
end

#text ⇒ String

Optional. 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 message. Corresponds to the JSON property text

Returns:

  • (String) 


5549
5550
5551
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5549

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:



5559
5560
5561
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5559

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) 


5567
5568
5569
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5567

def thread_reply
  @thread_reply
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
 
# File 'lib/google/apis/chat_v1/classes.rb', line 5575

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