View Source GoogleApi.Chat.V1.Model.Message (google_api_chat v0.33.0)
A message in a Google Chat space.
Attributes
-
actionResponse
(type:GoogleApi.Chat.V1.Model.ActionResponse.t
, default:nil
) - Input only. Parameters that a Chat app can use to configure how its response is posted. -
annotations
(type:list(GoogleApi.Chat.V1.Model.Annotation.t)
, default:nil
) - Output only. Annotations associated with thetext
in this message. -
argumentText
(type:String.t
, default:nil
) - Output only. Plain-text body of the message with all Chat app mentions stripped out. -
attachedGifs
(type:list(GoogleApi.Chat.V1.Model.AttachedGif.t)
, default:nil
) - Output only. GIF images that are attached to the message. -
attachment
(type:list(GoogleApi.Chat.V1.Model.Attachment.t)
, default:nil
) - User-uploaded attachment. -
cards
(type:list(GoogleApi.Chat.V1.Model.Card.t)
, default:nil
) - Deprecated: Usecards_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
andcards_v2
can have a maximum size of 32 KB. -
cardsV2
(type:list(GoogleApi.Chat.V1.Model.CardWithId.t)
, default:nil
) - 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 -
clientAssignedMessageId
(type:String.t
, default:nil
) - 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 themessageId
field when you create the message. For details, see Name a message. -
createTime
(type:DateTime.t
, default:nil
) - 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. -
deleteTime
(type:DateTime.t
, default:nil
) - Output only. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty. -
deletionMetadata
(type:GoogleApi.Chat.V1.Model.DeletionMetadata.t
, default:nil
) - Output only. Information about a deleted message. A message is deleted whendelete_time
is set. -
emojiReactionSummaries
(type:list(GoogleApi.Chat.V1.Model.EmojiReactionSummary.t)
, default:nil
) - Output only. The list of emoji reaction summaries on the message. -
fallbackText
(type:String.t
, default:nil
) - A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. -
formattedText
(type:String.t
, default:nil
) - Output only. Contains the messagetext
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 asU+1F600
for a grinning face emoji. For more information, see View text formatting sent in a message -
lastUpdateTime
(type:DateTime.t
, default:nil
) - 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. -
matchedUrl
(type:GoogleApi.Chat.V1.Model.MatchedUrl.t
, default:nil
) - Output only. A URL inspaces.messages.text
that matches a link preview pattern. For more information, see Preview links. -
name
(type:String.t
, default:nil
) - 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 theclientAssignedMessageId
field. For example,spaces/AAAAAAAAAAA/messages/client-custom-name
. For details, see Name a message. -
privateMessageViewer
(type:GoogleApi.Chat.V1.Model.User.t
, default:nil
) - 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 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. -
quotedMessageMetadata
(type:GoogleApi.Chat.V1.Model.QuotedMessageMetadata.t
, default:nil
) - 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. -
sender
(type:GoogleApi.Chat.V1.Model.User.t
, default:nil
) - Output only. The user who created the message. If your Chat app authenticates as a user, the output populates the username
andtype
. -
slashCommand
(type:GoogleApi.Chat.V1.Model.SlashCommand.t
, default:nil
) - Output only. Slash command information, if applicable. -
space
(type:GoogleApi.Chat.V1.Model.Space.t
, default:nil
) - If your Chat app authenticates as a user, the output populates the spacename
. -
text
(type:String.t
, default:nil
) - 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. -
thread
(type:GoogleApi.Chat.V1.Model.Thread.t
, default:nil
) - The thread the message belongs to. For example usage, see Start or reply to a message thread. -
threadReply
(type:boolean()
, default:nil
) - Output only. Whentrue
, the message is a response in a reply thread. Whenfalse
, 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 alwaysfalse
.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Chat.V1.Model.Message{ actionResponse: GoogleApi.Chat.V1.Model.ActionResponse.t() | nil, annotations: [GoogleApi.Chat.V1.Model.Annotation.t()] | nil, argumentText: String.t() | nil, attachedGifs: [GoogleApi.Chat.V1.Model.AttachedGif.t()] | nil, attachment: [GoogleApi.Chat.V1.Model.Attachment.t()] | nil, cards: [GoogleApi.Chat.V1.Model.Card.t()] | nil, cardsV2: [GoogleApi.Chat.V1.Model.CardWithId.t()] | nil, clientAssignedMessageId: String.t() | nil, createTime: DateTime.t() | nil, deleteTime: DateTime.t() | nil, deletionMetadata: GoogleApi.Chat.V1.Model.DeletionMetadata.t() | nil, emojiReactionSummaries: [GoogleApi.Chat.V1.Model.EmojiReactionSummary.t()] | nil, fallbackText: String.t() | nil, formattedText: String.t() | nil, lastUpdateTime: DateTime.t() | nil, matchedUrl: GoogleApi.Chat.V1.Model.MatchedUrl.t() | nil, name: String.t() | nil, privateMessageViewer: GoogleApi.Chat.V1.Model.User.t() | nil, quotedMessageMetadata: GoogleApi.Chat.V1.Model.QuotedMessageMetadata.t() | nil, sender: GoogleApi.Chat.V1.Model.User.t() | nil, slashCommand: GoogleApi.Chat.V1.Model.SlashCommand.t() | nil, space: GoogleApi.Chat.V1.Model.Space.t() | nil, text: String.t() | nil, thread: GoogleApi.Chat.V1.Model.Thread.t() | nil, threadReply: boolean() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.