A type alias to describe possible outgoing message types.
A type alias to describe the possible configurations to use when sending a message.
If a Promise-like type is used, the bot will send a typing indicator for the channel before resolving the Promise and sending its content.
A type-alias used to describe the possible options for message content. See discord.Message.IOutgoingMessageOptions for a full list of options.
The activity object included with this message, if set.
The application metadata used to render activity data for a message, if set.
An array of attachments sent with this message.
The author of this message. Always set for messages of this type.
The id of the text channel this message was sent in.
Note: You can fetch the full channel data with discord.Message.getChannel.
The text content of this message.
May contain up to 2000 characters.
The timestamp at which the message was last edited at, in ISO-8601 format.
An array of embeds included with this message.
A bit set of flags containing more information for this message.
The id of the guild this message was sent in. Always set for messages of this type.
Note: You can fetch the full guild data with discord.Message.getGuild.
The unique id for this message. The id can be used to find the time the message was created.
The guild member who authored this message. Always set for messages of this type.
An array of partial channel objects mentioned in this channel.
true
if this message mentions everyone.
An array of role ids mentioned in this channel.
An array of user objects, containing partial member objects, of users mentioned in this message.
The original message reference for cross-posted announcement messages.
true
if this message is pinned to the channel.
An array of emoji reactions added to this message.
The timestamp at which this message was sent at, in ISO-8601 format.
Messages of this type are always Message.Type.DEFAULT or Message.Type.REPLY.
The webhook id that created this message. Always null
for messages of this type.
Reacts to this message with the specified emoji.
If an error occurred, a discord.ApiError exception is thrown.
If passing a string, use a raw unicode emoji like ✅, or a custom emoji in the format of name:id
.
Attempts to permanently delete this message.
If an error occurred, a discord.ApiError exception is thrown.
Deletes all the reactions on this message.
Note: Will fire a Event.MESSAGE_REACTION_REMOVE_ALL event, if registered.
If an error occurred, a discord.ApiError exception is thrown.
Deletes all reactions for the emoji specified on this message.
If an error occurred, a discord.ApiError exception is thrown.
If passing a string, use a raw unicode emoji like ✅, or a custom emoji in the format of name:id
.
Deletes the bot user's own reaction to this message of the specified emoji.
If an error occurred, a discord.ApiError exception is thrown.
If passing a string, use a raw unicode emoji like ✅, or a custom emoji in the format of name:id
.
Deletes a user's reaction to the message.
If an error occurred, a discord.ApiError exception is thrown.
If passing a string, use a raw unicode emoji like ✅, or a custom emoji in the format of name:id
.
A user id or reference to a user object.
Attempts to edit a message. Messages may only be edited by their author.
If you wish to remove an embed from the message, set the embed
property to null.
The message content may be set to an empty string only if the message has or is receiving an embed with the edit.
Note: You may not modify allowedMentions
or tts
when editing a message, these only apply when a message is initially received.
If an error occurred, a discord.ApiError exception is thrown.
New message options for this message.
On success, the Promise resolves as the new message object.
Attempts to edit a message. Replaces the content with the new provided content.
Messages may only be edited if authored by the bot.
Note: If you'd like more options (embeds, allowed mentions, etc) see discord.Message.OutgoingMessageOptions.
If an error occurred, a discord.ApiError exception is thrown.
New content for this message.
On success, the Promise resolves as the new message object.
Attempts to edit a message. Sets the content to an empty string and adds or updates the embed associated with this message.
Messages may only be edited if authored by the bot.
If an error occurred, a discord.ApiError exception is thrown.
A new discord.Embed for this message.
On success, the Promise resolves as the new message object.
Fetches data for the channel this message was sent in.
Fetches the data for the guild this message was sent in.
If the message was not sent in a guild, the Promise resolves as null
.
Does the same thing as .reply, but adds an inline reply referencing this message.
If reply is set on the settings resolved by outgoingMessageOptions, then that will override the inline reply set by this function.
Outgoing message options.
Does the same thing as .reply, but adds an inline reply referencing this message.
Content to use for the outgoing message.
Does the same thing as .reply, but adds an inline reply referencing this message.
The embed object you'd like to send to the channel.
Provides an async iterator over a list of users that reacted to the message with the given emoji.
Attempts to send a message with additional options (embed, tts, allowedMentions) to the channel this message was sent in.
Note: content
OR embed
must be set on the options properties.
See discord.Message.OutgoingMessageOptions for descriptions on possible options.
If an error occurs sending this message, a discord.ApiError exception will be thrown.
Outgoing message options.
Attempts to send a simple text message to the channel this message was sent in.
Note: If you'd like to send an embed or pass additional options, see discord.Message.OutgoingMessageOptions
If an error occurs sending this message, a discord.ApiError exception will be thrown.
Content to use for the outgoing message.
Attempts to send an discord.Embed to the channel this message was sent in.
If an error occurs sending this message, a discord.ApiError exception will be thrown.
The embed object you'd like to send to the channel.
Changes the pinned status of this message.
true
if the message should be pinned, otherwise false
.
Generated using TypeDoc
A type alias to describe any message class type.