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.



3498
3499
3500
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3498

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 its response is posted. Corresponds to the JSON property actionResponse

Returns:



3320
3321
3322
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3320

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:



3325
3326
3327
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3325

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) 


3331
3332
3333
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3331

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:



3336
3337
3338
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3336

def attached_gifs
  @attached_gifs
end

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

User-uploaded attachment. Corresponds to the JSON property attachment

Returns:



3341
3342
3343
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3341

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:



3349
3350
3351
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3349

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 Design dynamic, interactive, and consistent UIs with cards. Corresponds to the JSON property cardsV2

Returns:



3359
3360
3361
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3359

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. Assigning a custom name lets a Chat app recall the message without saving the message name from the response body returned when creating the message. Assigning a custom name doesn't replace the generated name field, the message's resource name. Instead, it sets the custom name as the clientAssignedMessageId field, which you can reference while processing later operations, like updating or deleting the message. For example usage, see Name a created message. Corresponds to the JSON property clientAssignedMessageId

Returns:

  • (String) 


3375
3376
3377
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3375

def client_assigned_message_id
  @client_assigned_message_id
end

#create_time ⇒ String

For spaces created in Chat, the time at which the message was created. This field is output only, except when used in imported spaces. Developer Preview: For imported 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) 


3384
3385
3386
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3384

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) 


3390
3391
3392
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3390

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:



3396
3397
3398
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3396

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:



3401
3402
3403
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3401

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) 


3407
3408
3409
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3407

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, and monospace block. * 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. For more information, see View text formatting sent in a message Corresponds to the JSON property formattedText

Returns:

  • (String) 


3423
3424
3425
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3423

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) 


3429
3430
3431
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3429

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:



3436
3437
3438
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3436

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) 


3442
3443
3444
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3442

def name
  @name
end

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

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

Returns:



3447
3448
3449
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3447

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:



3455
3456
3457
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3455

def sender
  @sender
end

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

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

Returns:



3461
3462
3463
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3461

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:



3467
3468
3469
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3467

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) 


3477
3478
3479
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3477

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:



3487
3488
3489
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3487

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) 


3495
3496
3497
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3495

def thread_reply
  @thread_reply
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3503

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)
  @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)
  @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