> For the complete documentation index, see [llms.txt](https://legacy.docs.touchguild.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://legacy.docs.touchguild.com/documentation/select-version/v.0.1.7/components/message.md). # Message ## Properties | Property | Description | Type | | --------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \_data | Original message data. | Object | | \_client | the client that receives the channel data | [Client](/documentation/select-version/v.0.1.7/components/client.md) | | id | id of the message | String | | type | type of message ('user' or 'system') | String | | channel | channel where the message has been sent | [Channel](/documentation/select-version/v.0.1.7/components/channel.md) | | member | message author | [Member](/documentation/select-version/v.0.1.7/components/member.md) | | guildID | id of the message's server | String | | channelID | id of the message's channel | String | | content | message content | String | | embeds | message's embed(s) | Array\ | | isPrivate | is message private? true/false | Boolean | | isSilent | if the message doesn't notify a user | Boolean | | mentions | Message mentions object | Object ([MentionsType](https://github.com/DinographicPixels/touchguild-docs/blob/main/documentation/select-version/v.0.1.7/types/mentionstype.md)) | | \_createdAt | timestamp that the message was created at | Number | | memberID | id of the message author | String | | \_updatedAt | timestamp that the message was updated at | Number\|null | | \_deletedAt | Timestamp (unix epoch time) of the message's deletion. | Number\|null | | webhookID | The ID of the webhook who created this message, if it was created by a webhook | String | | replyMessageIds | List of ids mentioned in the message | Array | | \_lastMessageID | last message sent with the message itself (cache) | String | | \_originalMessageID | Original message, used to reply this one (cache) | String | | \_originalMessageBool | Used by the system to detect if the original message id has been transfered | Boolean | | | | | | oldContent | old message content if edited | String | | createdAt | string representation of the \_createdAt timestamp. | Date | | updatedAt | string representation of the \_updatedAt timestamp. | Date\|void | | deletedAt | string representation of the \_deletedAt timestamp. | Date\|void | | member | Get the member component, which returns Member when message guildID and memberID is defined or if Member is cached. | Member\|undefined | | guild | Guild component where the message has been sent | Guild | | channel | Channel component where the message has been sent on | [Channel](/documentation/select-version/v.0.1.7/components/channel.md) | ## Constructor ```javascript new Message(rawData, client, params) ``` | Properties | Description | Type | Required? | | ------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------- | --------- | | rawData | raw data received from ws and converted to JSON | Object | true | | client | Client | [Client](/documentation/select-version/v.0.1.7/components/client.md) | true | | params? | Object of params | Object | false | | params.oldMessage? | old message component, if cached. | [Message](/documentation/select-version/v.0.1.7/components/message.md) | false | | params.originalMessageID? | ID of the transfered original message. If existant. | String | false | {% hint style="danger" %} Do not use this constructor unless you know what you're doing. This constructor is used to return you rawdata into component. {% endhint %} ## Methods ### createMessage(options) Create a message in the message's channel. | Properties | Description | Type | Required? | | ----------------------- | ---------------------------------------------------------- | -------------- | --------- | | options | message's options | Object | true | | options.content | message content | String | false | | options.embeds | message's embeds | Array\ | false | | options.replyMessageIds | list of message id to reply | Array\ | false | | options.isSilent | notify user(s)? | Boolean | false | | options.isPrivate | message will only be seen by those mentioned or replied to | Boolean | false | > Returns: Promise<[Message](/documentation/select-version/v.0.1.7/components/message.md)> ### edit(newMessage) Update/edit the message. | Properties | Description | Type | Required? | | ------------------ | ---------------- | ------ | --------- | | newMessage | edit options | Object | true | | newMessage.content | message content | String | false | | newMessage.embeds | message's embeds | Object | false | > Returns: Promise<[Message](/documentation/select-version/v.0.1.7/components/message.md)> ### delete() Delete the message. > Returns: Promise\ ### editLastMessage(newMessage) Edit the last message sent with the message itself. | Properties | Description | Type | Required? | | ------------------ | ---------------- | ------ | --------- | | newMessage | edit options | Object | true | | newMessage.content | message content | String | false | | newMessage.embeds | message's embeds | Object | false | > Returns: Promise<[Message](/documentation/select-version/v.0.1.7/components/message.md)> ### deleteLastMessage() Delete the last message sent with he message itself. > Returns: Promise\ ### editOriginalMessage(newMessage) Edit the message's original message, if existant. | Properties | Description | Type | Required? | | ------------------ | ---------------- | ------ | --------- | | newMessage | edit options | Object | true | | newMessage.content | message content | String | false | | newMessage.embeds | message's embeds | Object | false | > Returns: Promise<[Message](/documentation/select-version/v.0.1.7/components/message.md)> ### deleteOriginalMessage() Delete the message's original message, if existant. > Returns: Promise\ ### addReaction(reaction) Add a reaction to the message. | Properties | Description | Type | Required? | | ---------- | ----------- | ------ | --------- | | reaction | reaction id | Number | true | > Returns: Promise\ ### removeReaction(reaction) Remove a specific reaction from the message. | Properties | Description | Type | Required? | | ---------- | ----------- | ------ | --------- | | reaction | reaction id | Number | true | > Returns: Promise\ --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://legacy.docs.touchguild.com/documentation/select-version/v.0.1.7/components/message.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.