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.



3749
3750
3751
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3749

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:



3562
3563
3564
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3562

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:



3567
3568
3569
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3567

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) 


3573
3574
3575
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3573

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:



3578
3579
3580
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3578

def attached_gifs
  @attached_gifs
end

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

User-uploaded attachment. Corresponds to the JSON property attachment

Returns:



3583
3584
3585
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3583

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:



3591
3592
3593
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3591

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. Card builder Corresponds to the JSON property cardsV2

Returns:



3601
3602
3603
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3601

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) 


3611
3612
3613
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3611

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) 


3620
3621
3622
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3620

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) 


3626
3627
3628
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3626

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:



3632
3633
3634
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3632

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:



3637
3638
3639
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3637

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) 


3643
3644
3645
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3643

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


3659
3660
3661
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3659

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) 


3665
3666
3667
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3665

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:



3672
3673
3674
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3672

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/chat/api/guides/v1/messages/ create#name_a_created_message). Corresponds to the JSON propertyname`

Returns:

  • (String) 


3685
3686
3687
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3685

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:



3693
3694
3695
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3693

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:



3698
3699
3700
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3698

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:



3706
3707
3708
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3706

def sender
  @sender
end

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

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

Returns:



3712
3713
3714
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3712

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:



3718
3719
3720
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3718

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) 


3728
3729
3730
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3728

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:



3738
3739
3740
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3738

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) 


3746
3747
3748
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3746

def thread_reply
  @thread_reply
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
 
# File 'lib/google/apis/chat_v1/classes.rb', line 3754

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