Skip to main content

Message (Object)

Description

No description



Fields

NameDescription
_id - String!The ID of the message
addressSignature - String!The address signature of the message
attachmentIds - [String!]!The IDs of any attachments on the message
attachments - [File!]
authorId - String!The member ID of the author in the site
authorName - StringCached copy of the author’s name. The property is not updated if the author name gets changed after the message is sent.
authorParticipantId - String!The participant ID of the author in the chat
content - StringThe content of the message
contentType - MessageContentType!The content type of the message
embedIds - [String!]!The IDs of any embeds on the message
embeds - [Embed!]
imageIds - [String!]!The IDs of any images on the message. This is specifically for in-line images
images - [Image!]
legacyId - StringThe legacy ID of the message
mentionedMemberIds - [String!]!The IDs of any members mentioned in the message
mentionedParticipantIds - [String!]!The IDs of any participants mentioned in the message
meta - MessageMetadataMeta information of the message. May contain additional information regarding chat logs or contextual data of the message
nonce - StringA nonce provided by the client. Can be used for optimistic updates
pageId - String!The page ID of the message
pos - Int!A global index for the message indicating it's position in the chat
preview - StringThe preview of the message
sentAt - DateTime!The date the message was sent

type Message {
_id: String!
addressSignature: String!
attachmentIds: [String!]!
attachments: [File!]
authorId: String!
authorName: String
authorParticipantId: String!
content: String
contentType: MessageContentType!
embedIds: [String!]!
embeds: [Embed!]
imageIds: [String!]!
images: [Image!]
legacyId: String
mentionedMemberIds: [String!]!
mentionedParticipantIds: [String!]!
meta: MessageMetadata
nonce: String
pageId: String!
pos: Int!
preview: String
sentAt: DateTime!
}