Reference documentation and code samples for the Google Apps Chat V1 Client class Message.
A message in a Google Chat space.
Generated from protobuf message google.chat.v1.Message
Namespace
Google \ Apps \ Chat \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. 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
.
↳ sender
User
Output only. The user who created the message. If your Chat app authenticates as a user
, the output populates the user
name
and type
.
↳ create_time
Google\Protobuf\Timestamp
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.
↳ last_update_time
Google\Protobuf\Timestamp
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.
↳ delete_time
Google\Protobuf\Timestamp
Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.
↳ 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 .
↳ 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 <users/{user}>
. * * Custom hyperlinks using the format <{url}|{rendered_text}>
where the first string is the URL and the second is the rendered text—for example, <http://example.com|custom text>
. * * 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
↳ cards
array< ContextualAddOnMarkup\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.
↳ cards_v2
array< CardWithId
>
Optional. 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 how to create a message that contains cards, see Send a message . Card builder
↳ annotations
array< 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.
↳ thread
Thread
The thread the message belongs to. For example usage, see Start or reply to a message thread .
↳ space
Space
Output only. If your Chat app authenticates as a user
, the output only populates the space
name
.
↳ 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.
↳ action_response
ActionResponse
Input only. Parameters that a Chat app can use to configure how its response is posted.
↳ argument_text
string
Output only. Plain-text body of the message with all Chat app mentions stripped out.
↳ slash_command
↳ attachment
↳ matched_url
MatchedUrl
Output only. A URL in spaces.messages.text
that matches a link preview pattern. For more information, see Preview links
.
↳ thread_reply
bool
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
.
↳ 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
.
↳ emoji_reaction_summaries
↳ private_message_viewer
User
Optional. 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. To include this field in your request, you must call the Chat API using app authentication and omit the following: * * Attachments * * Accessory widgets For details, see Send a message privately .
↳ deletion_metadata
DeletionMetadata
Output only. Information about a deleted message. A message is deleted when delete_time
is set.
↳ quoted_message_metadata
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.
↳ attached_gifs
↳ accessory_widgets
array< 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 .
getName
Identifier. 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
.
string
setName
Identifier. 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
.
var
string
$this
getSender
Output only. The user who created the message.
If your Chat app authenticates as a
user
,
the output populates the user
name
and type
.
hasSender
clearSender
setSender
Output only. The user who created the message.
If your Chat app authenticates as a
user
,
the output populates the user
name
and type
.
$this
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.
hasCreateTime
clearCreateTime
setCreateTime
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.
$this
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.
hasLastUpdateTime
clearLastUpdateTime
setLastUpdateTime
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.
$this
getDeleteTime
Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty.
$this
getText
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 .
string
setText
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 .
var
string
$this
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 for bold, italic, strikethrough, monospace, monospace block, and bulleted list.
-
User mentions using the format
<users/{user}>. - Custom hyperlinks using the format
<{url}|{rendered_text}>where the first string is the URL and the second is the rendered text—for example,<http://example.com|custom text>. - 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
string
setFormattedText
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
<users/{user}>. - Custom hyperlinks using the format
<{url}|{rendered_text}>where the first string is the URL and the second is the rendered text—for example,<http://example.com|custom text>. - 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
var
string
$this
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.
setCards
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.
$this
getCardsV2
Optional. 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 how to create a message that contains cards, see Send a message . Card builder
setCardsV2
Optional. 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 how to create a message that contains cards, see Send a message . Card builder
$this
getAnnotations
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.
setAnnotations
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.
$this
getThread
The thread the message belongs to. For example usage, see Start or reply to a message thread .
hasThread
clearThread
setThread
The thread the message belongs to. For example usage, see Start or reply to a message thread .
$this
getSpace
Output only. If your Chat app authenticates as a
user
,
the output only populates the space
name
.
hasSpace
clearSpace
setSpace
Output only. If your Chat app authenticates as a
user
,
the output only populates the space
name
.
$this
getFallbackText
Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
string
setFallbackText
Optional. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.
var
string
$this
getActionResponse
Input only. Parameters that a Chat app can use to configure how its response is posted.
hasActionResponse
clearActionResponse
setActionResponse
Input only. Parameters that a Chat app can use to configure how its response is posted.
$this
getArgumentText
Output only. Plain-text body of the message with all Chat app mentions stripped out.
string
setArgumentText
Output only. Plain-text body of the message with all Chat app mentions stripped out.
var
string
$this
getSlashCommand
Output only. Slash command information, if applicable.
hasSlashCommand
clearSlashCommand
setSlashCommand
Output only. Slash command information, if applicable.
$this
getAttachment
Optional. User-uploaded attachment.
setAttachment
Optional. User-uploaded attachment.
$this
getMatchedUrl
Output only. A URL in spaces.messages.text
that matches a link preview
pattern. For more information, see Preview
links
.
hasMatchedUrl
clearMatchedUrl
setMatchedUrl
Output only. A URL in spaces.messages.text
that matches a link preview
pattern. For more information, see Preview
links
.
$this
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
.
bool
setThreadReply
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
.
var
bool
$this
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
field when you create the message. For details, see Name a
message
.
string
setClientAssignedMessageId
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
.
var
string
$this
getEmojiReactionSummaries
Output only. The list of emoji reaction summaries on the message.
setEmojiReactionSummaries
Output only. The list of emoji reaction summaries on the message.
$this
getPrivateMessageViewer
Optional. 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. To include this field in your request, you must call the Chat API using app authentication and omit the following:
- Attachments
- Accessory widgets For details, see Send a message privately .
hasPrivateMessageViewer
clearPrivateMessageViewer
setPrivateMessageViewer
Optional. 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. To include this field in your request, you must call the Chat API using app authentication and omit the following:
- Attachments
- Accessory widgets For details, see Send a message privately .
$this
getDeletionMetadata
Output only. Information about a deleted message. A message is deleted when delete_time
is set.
hasDeletionMetadata
clearDeletionMetadata
setDeletionMetadata
Output only. Information about a deleted message. A message is deleted when delete_time
is set.
$this
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.
hasQuotedMessageMetadata
clearQuotedMessageMetadata
setQuotedMessageMetadata
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.
$this
getAttachedGifs
Output only. GIF images that are attached to the message.
setAttachedGifs
Output only. GIF images that are attached to the message.
$this
getAccessoryWidgets
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 .
setAccessoryWidgets
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 .
$this
