Message (Google Chat API v1-rev20240220-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.chat.v1.model.Message

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Message
extends com.google.api.client.json.GenericJson
```
A message in a Google Chat space.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Chat API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Message()

Constructors
Constructor and Description
`Message()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Message`	`clone()`
`ActionResponse`	`getActionResponse()` Input only.
`List<Annotation>`	`getAnnotations()` Output only.
`String`	`getArgumentText()` Output only.
`List<AttachedGif>`	`getAttachedGifs()` Output only.
`List<Attachment>`	`getAttachment()` User-uploaded attachment.
`List<Card>`	`getCards()` Deprecated: Use `cards_v2` instead.
`List<CardWithId>`	`getCardsV2()` An array of [cards](https://developers.google.com/chat/api/reference/rest/v1/cards).
`String`	`getClientAssignedMessageId()` Optional.
`String`	`getCreateTime()` Optional.
`String`	`getDeleteTime()` Output only.
`DeletionMetadata`	`getDeletionMetadata()` Output only.
`List<EmojiReactionSummary>`	`getEmojiReactionSummaries()` Output only.
`String`	`getFallbackText()` A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
`String`	`getFormattedText()` Output only.
`String`	`getLastUpdateTime()` Output only.
`MatchedUrl`	`getMatchedUrl()` Output only.
`String`	`getName()` Resource name of the message.
`User`	`getPrivateMessageViewer()` Immutable.
`QuotedMessageMetadata`	`getQuotedMessageMetadata()` Output only.
`User`	`getSender()` Output only.
`SlashCommand`	`getSlashCommand()` Output only.
`Space`	`getSpace()` If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [space](https://developers.google.com/chat/api/reference/rest/v1/spaces) `name`.
`String`	`getText()` Plain-text body of the message.
`Thread`	`getThread()` The thread the message belongs to.
`Boolean`	`getThreadReply()` Output only.
`Message`	`set(String fieldName, Object value)`
`Message`	`setActionResponse(ActionResponse actionResponse)` Input only.
`Message`	`setAnnotations(List<Annotation> annotations)` Output only.
`Message`	`setArgumentText(String argumentText)` Output only.
`Message`	`setAttachedGifs(List<AttachedGif> attachedGifs)` Output only.
`Message`	`setAttachment(List<Attachment> attachment)` User-uploaded attachment.
`Message`	`setCards(List<Card> cards)` Deprecated: Use `cards_v2` instead.
`Message`	`setCardsV2(List<CardWithId> cardsV2)` An array of [cards](https://developers.google.com/chat/api/reference/rest/v1/cards).
`Message`	`setClientAssignedMessageId(String clientAssignedMessageId)` Optional.
`Message`	`setCreateTime(String createTime)` Optional.
`Message`	`setDeleteTime(String deleteTime)` Output only.
`Message`	`setDeletionMetadata(DeletionMetadata deletionMetadata)` Output only.
`Message`	`setEmojiReactionSummaries(List<EmojiReactionSummary> emojiReactionSummaries)` Output only.
`Message`	`setFallbackText(String fallbackText)` A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
`Message`	`setFormattedText(String formattedText)` Output only.
`Message`	`setLastUpdateTime(String lastUpdateTime)` Output only.
`Message`	`setMatchedUrl(MatchedUrl matchedUrl)` Output only.
`Message`	`setName(String name)` Resource name of the message.
`Message`	`setPrivateMessageViewer(User privateMessageViewer)` Immutable.
`Message`	`setQuotedMessageMetadata(QuotedMessageMetadata quotedMessageMetadata)` Output only.
`Message`	`setSender(User sender)` Output only.
`Message`	`setSlashCommand(SlashCommand slashCommand)` Output only.
`Message`	`setSpace(Space space)` If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [space](https://developers.google.com/chat/api/reference/rest/v1/spaces) `name`.
`Message`	`setText(String text)` Plain-text body of the message.
`Message`	`setThread(Thread thread)` The thread the message belongs to.
`Message`	`setThreadReply(Boolean threadReply)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Message
```
public Message()
```
- Method Detail
  - getActionResponse
```
public ActionResponse getActionResponse()
```
    Input only. Parameters that a Chat app can use to configure how its response is posted.
    
    Returns:
    
    value or null for none
  - setActionResponse
```
public Message setActionResponse(ActionResponse actionResponse)
```
    Input only. Parameters that a Chat app can use to configure how its response is posted.
    
    Parameters:
    
    actionResponse - actionResponse or null for none
  - getAnnotations
```
public List<Annotation> getAnnotations()
```
    Output only. Annotations associated with the `text` in this message.
    
    Returns:
    
    value or null for none
  - setAnnotations
```
public Message setAnnotations(List<Annotation> annotations)
```
    Output only. Annotations associated with the `text` in this message.
    
    Parameters:
    
    annotations - annotations or null for none
  - getArgumentText
```
public String getArgumentText()
```
    Output only. Plain-text body of the message with all Chat app mentions stripped out.
    
    Returns:
    
    value or null for none
  - setArgumentText
```
public Message setArgumentText(String argumentText)
```
    Output only. Plain-text body of the message with all Chat app mentions stripped out.
    
    Parameters:
    
    argumentText - argumentText or null for none
  - getAttachedGifs
```
public List<AttachedGif> getAttachedGifs()
```
    Output only. GIF images that are attached to the message.
    
    Returns:
    
    value or null for none
  - setAttachedGifs
```
public Message setAttachedGifs(List<AttachedGif> attachedGifs)
```
    Output only. GIF images that are attached to the message.
    
    Parameters:
    
    attachedGifs - attachedGifs or null for none
  - getAttachment
```
public List<Attachment> getAttachment()
```
    User-uploaded attachment.
    
    Returns:
    
    value or null for none
  - setAttachment
```
public Message setAttachment(List<Attachment> attachment)
```
    User-uploaded attachment.
    
    Parameters:
    
    attachment - attachment or null for none
  - getCards
```
public List<Card> getCards()
```
    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.
    
    Returns:
    
    value or null for none
  - setCards
```
public Message setCards(List<Card> cards)
```
    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.
    
    Parameters:
    
    cards - cards or null for none
  - getCardsV2
```
public List<CardWithId> getCardsV2()
```
    An array of [cards](https://developers.google.com/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the messages can't contain cards. To learn about cards and how to create them, see [Design dynamic, interactive, and consistent UIs with cards](https://developers.google.com/chat/ui). [Card builder](https://addons.gsuite.google.com/uikit/builder)
    
    Returns:
    
    value or null for none
  - setCardsV2
```
public Message setCardsV2(List<CardWithId> cardsV2)
```
    An array of [cards](https://developers.google.com/chat/api/reference/rest/v1/cards). Only Chat apps can create cards. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the messages can't contain cards. To learn about cards and how to create them, see [Design dynamic, interactive, and consistent UIs with cards](https://developers.google.com/chat/ui). [Card builder](https://addons.gsuite.google.com/uikit/builder)
    
    Parameters:
    
    cardsV2 - cardsV2 or null for none
  - getClientAssignedMessageId
```
public String getClientAssignedMessageId()
```
    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`](https://developers.g oogle.com/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google. com/chat/api/guides/v1/messages/create#name_a_created_message).
    
    Returns:
    
    value or null for none
  - setClientAssignedMessageId
```
public Message setClientAssignedMessageId(String clientAssignedMessageId)
```
    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`](https://developers.g oogle.com/chat/api/reference/rest/v1/spaces.messages/create#body.QUERY_PARAMETERS.message_id) field when you create the message. For details, see [Name a message](https://developers.google. com/chat/api/guides/v1/messages/create#name_a_created_message).
    
    Parameters:
    
    clientAssignedMessageId - clientAssignedMessageId or null for none
  - getCreateTime
```
public String getCreateTime()
```
    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.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Message setCreateTime(String createTime)
```
    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.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDeleteTime
```
public String getDeleteTime()
```
    Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.
    
    Returns:
    
    value or null for none
  - setDeleteTime
```
public Message setDeleteTime(String deleteTime)
```
    Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.
    
    Parameters:
    
    deleteTime - deleteTime or null for none
  - getDeletionMetadata
```
public DeletionMetadata getDeletionMetadata()
```
    Output only. Information about a deleted message. A message is deleted when `delete_time` is set.
    
    Returns:
    
    value or null for none
  - setDeletionMetadata
```
public Message setDeletionMetadata(DeletionMetadata deletionMetadata)
```
    Output only. Information about a deleted message. A message is deleted when `delete_time` is set.
    
    Parameters:
    
    deletionMetadata - deletionMetadata or null for none
  - getEmojiReactionSummaries
```
public List<EmojiReactionSummary> getEmojiReactionSummaries()
```
    Output only. The list of emoji reaction summaries on the message.
    
    Returns:
    
    value or null for none
  - setEmojiReactionSummaries
```
public Message setEmojiReactionSummaries(List<EmojiReactionSummary> emojiReactionSummaries)
```
    Output only. The list of emoji reaction summaries on the message.
    
    Parameters:
    
    emojiReactionSummaries - emojiReactionSummaries or null for none
  - getFallbackText
```
public String getFallbackText()
```
    A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
    
    Returns:
    
    value or null for none
  - setFallbackText
```
public Message setFallbackText(String fallbackText)
```
    A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
    
    Parameters:
    
    fallbackText - fallbackText or null for none
  - getFormattedText
```
public String getFormattedText()
```
    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](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, and monospace block. * [User mentions](https://developers.google.com/chat/format- messages#messages-@mention) 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](https://developers.google.com/chat /format-messages#view_text_formatting_sent_in_a_message)
    
    Returns:
    
    value or null for none
  - setFormattedText
```
public Message setFormattedText(String formattedText)
```
    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](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, and monospace block. * [User mentions](https://developers.google.com/chat/format- messages#messages-@mention) 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](https://developers.google.com/chat /format-messages#view_text_formatting_sent_in_a_message)
    
    Parameters:
    
    formattedText - formattedText or null for none
  - getLastUpdateTime
```
public String getLastUpdateTime()
```
    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.
    
    Returns:
    
    value or null for none
  - setLastUpdateTime
```
public Message setLastUpdateTime(String lastUpdateTime)
```
    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.
    
    Parameters:
    
    lastUpdateTime - lastUpdateTime or null for none
  - getMatchedUrl
```
public MatchedUrl getMatchedUrl()
```
    Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links).
    
    Returns:
    
    value or null for none
  - setMatchedUrl
```
public Message setMatchedUrl(MatchedUrl matchedUrl)
```
    Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, see [Preview links](https://developers.google.com/chat/how-tos/preview-links).
    
    Parameters:
    
    matchedUrl - matchedUrl or null for none
  - getName
```
public String getName()
```
    Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is 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 replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://dev elopers.google.com/chat/api/guides/v1/messages/create#name_a_created_message).
    
    Returns:
    
    value or null for none
  - setName
```
public Message setName(String name)
```
    Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is 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 replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://dev elopers.google.com/chat/api/guides/v1/messages/create#name_a_created_message).
    
    Parameters:
    
    name - name or null for none
  - getPrivateMessageViewer
```
public User getPrivateMessageViewer()
```
    Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages. Only Chat apps can send private messages. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users) to send a message, the message can't be private and must omit this field. For details, see [Send private messages to Google Chat users](https://developers.google.com/chat/api/guides/v1/messages/private).
    
    Returns:
    
    value or null for none
  - setPrivateMessageViewer
```
public Message setPrivateMessageViewer(User privateMessageViewer)
```
    Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages. Only Chat apps can send private messages. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users) to send a message, the message can't be private and must omit this field. For details, see [Send private messages to Google Chat users](https://developers.google.com/chat/api/guides/v1/messages/private).
    
    Parameters:
    
    privateMessageViewer - privateMessageViewer or null for none
  - getQuotedMessageMetadata
```
public QuotedMessageMetadata getQuotedMessageMetadata()
```
    Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.
    
    Returns:
    
    value or null for none
  - setQuotedMessageMetadata
```
public Message setQuotedMessageMetadata(QuotedMessageMetadata quotedMessageMetadata)
```
    Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.
    
    Parameters:
    
    quotedMessageMetadata - quotedMessageMetadata or null for none
  - getSender
```
public User getSender()
```
    Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`.
    
    Returns:
    
    value or null for none
  - setSender
```
public Message setSender(User sender)
```
    Output only. The user who created the message. If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [user](https://developers.google.com/chat/api/reference/rest/v1/User) `name` and `type`.
    
    Parameters:
    
    sender - sender or null for none
  - getSlashCommand
```
public SlashCommand getSlashCommand()
```
    Output only. Slash command information, if applicable.
    
    Returns:
    
    value or null for none
  - setSlashCommand
```
public Message setSlashCommand(SlashCommand slashCommand)
```
    Output only. Slash command information, if applicable.
    
    Parameters:
    
    slashCommand - slashCommand or null for none
  - getSpace
```
public Space getSpace()
```
    If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [space](https://developers.google.com/chat/api/reference/rest/v1/spaces) `name`.
    
    Returns:
    
    value or null for none
  - setSpace
```
public Message setSpace(Space space)
```
    If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [space](https://developers.google.com/chat/api/reference/rest/v1/spaces) `name`.
    
    Parameters:
    
    space - space or null for none
  - getText
```
public String getText()
```
    Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/how-tos/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/chat/format- messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/chat/api/guides/v1/messages/create #create-text-messages).
    
    Returns:
    
    value or null for none
  - setText
```
public Message setText(String text)
```
    Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/how-tos/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/chat/format- messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/chat/api/guides/v1/messages/create #create-text-messages).
    
    Parameters:
    
    text - text or null for none
  - getThread
```
public Thread getThread()
```
    The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/api/guides/v1/messages/create#create-message- thread).
    
    Returns:
    
    value or null for none
  - setThread
```
public Message setThread(Thread thread)
```
    The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/chat/api/guides/v1/messages/create#create-message- thread).
    
    Parameters:
    
    thread - thread or null for none
  - getThreadReply
```
public Boolean getThreadReply()
```
    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`.
    
    Returns:
    
    value or null for none
  - setThreadReply
```
public Message setThreadReply(Boolean threadReply)
```
    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`.
    
    Parameters:
    
    threadReply - threadReply or null for none
  - set
```
public Message set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Message clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Message

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Message

Method Detail

getActionResponse

setActionResponse

getAnnotations

setAnnotations

getArgumentText

setArgumentText

getAttachedGifs

setAttachedGifs

getAttachment

setAttachment

getCards

setCards

getCardsV2

setCardsV2

getClientAssignedMessageId

setClientAssignedMessageId

getCreateTime

setCreateTime

getDeleteTime

setDeleteTime

getDeletionMetadata

setDeletionMetadata

getEmojiReactionSummaries

setEmojiReactionSummaries

getFallbackText

setFallbackText

getFormattedText

setFormattedText

getLastUpdateTime

setLastUpdateTime

getMatchedUrl

setMatchedUrl

getName

setName

getPrivateMessageViewer

setPrivateMessageViewer

getQuotedMessageMetadata

setQuotedMessageMetadata

getSender

setSender

getSlashCommand

setSlashCommand

getSpace

setSpace

getText

setText

getThread

setThread

getThreadReply

setThreadReply

set

clone