Class Message<T>

Represents a message.

Type Parameters

T extends AnyTextableChannel | Uncached = AnyTextableChannel | Uncached

Hierarchy (view full)

Base
- Message

Constructors

constructor

new Message<T>(data, client): Message<T>
Type Parameters
- T extends Uncached | AnyTextableChannel = Uncached | AnyTextableChannel
Parameters
- data: RawMessage
- client: Client<ClientEvents>
Returns Message<T>
Overrides Base.constructor
- Defined in lib/structures/Message.ts:136

Properties

`Optional` activity

activity?: MessageActivity

The activity associated with this message.

`Optional` application

application?: ClientApplication | PartialApplication

The application associated with this message. This can be present in two scenarios:

If the message was from an interaction or application owned webhook (ClientApplication if any shard has reached READY, PartialApplication otherwise).
If the message has a rich presence embed (PartialApplication)

applicationID

applicationID: null | string

The ID of the application associated with this message. This can be present in two scenarios:

If the message was from an interaction or application owned webhook (ClientApplication if any shard has reached READY, PartialApplication otherwise).
If the message has a rich presence embed (PartialApplication)

attachments

attachments: TypedCollection<RawAttachment, Attachment, []>

The attachments on this message.

author

author: User

The author of this message.

`Optional` call

call?: Call

The call associated with this message.

channelID

channelID: string

The ID of the channel this message was created in.

client

client: Client<ClientEvents>

components

components: MessageComponent[]

The components on this message.

content

content: string

The content of this message.

editedTimestamp

editedTimestamp: null | Date

The timestamp at which this message was last edited.

embeds

embeds: Embed[]

The embeds on this message.

flags

flags: number

The flags on this message.

guildID

guildID: T extends AnyTextableGuildChannel
? string
: null | string

The ID of the guild this message is in.

id

id: string

`Optional` interaction

interaction?: MessageInteraction

The interaction info, if this message was the result of an interaction.

Deprecated

Use Message#interactionMetadata instead.

`Optional` interactionMetadata

interactionMetadata?: AnyMessageInteractionMetadata

The interaction info, if this message was the result of an interaction.

member

member: T extends AnyTextableGuildChannel
? Member
: undefined | Member

The member that created this message, if this message is in a guild.

`Optional` mentionChannels

mentionChannels?: ChannelMention[]

Channels mentioned in a CROSSPOSTED channel follower message. See Discord's docs for more information.

mentions

mentions: MessageMentions

The mentions in this message.

`Optional` messageReference

messageReference?: MessageReference

If this message is a REPLY or THREAD_STARTER_MESSAGE, some info about the referenced message.

`Optional` messageSnapshots

messageSnapshots?: MessageSnapshot[]

If this message is a forwarded message, the partial contents of that message.

`Optional` nonce

nonce?: string | number

A nonce for ensuring a message was sent.

pinned

pinned: boolean

If this message is pinned.

`Optional` poll

poll?: Poll

The poll on this message, if any.

`Optional` pollResults

pollResults?: MessagePollResults

The poll results extracted from the embeds of this message. This will only be present for POLL_RESULT messages.

`Optional` position

position?: number

This message's relative position, if in a thread.

reactions

reactions: MessageReaction[]

The reactions on this message.

`Optional` referencedMessage

referencedMessage?: null | Message<Uncached | AnyTextableChannel>

If this message is a REPLY or THREAD_STARTER_MESSAGE, this will be the message that's referenced.

`Optional` roleSubscriptionData

roleSubscriptionData?: RoleSubscriptionData

The data of the role subscription purchase or renewal that prompted this message.

`Optional` stickerItems

stickerItems?: StickerItem[]

The sticker items on this message.

`Optional` thread

thread?: AnyThreadChannel

The thread associated with this message, if any.

timestamp

timestamp: Date

The timestamp at which this message was sent.

tts

tts: boolean

If this message was read aloud.

type

type: MessageTypes

The type of this message.

`Optional` webhookID

webhookID?: string

The webhook associated with this message, if sent via a webhook. This only has an id property.

Accessors

channel

get channel(): T extends AnyTextableChannel
? T<T>
: undefined
The channel this message was created in.

Returns T extends AnyTextableChannel
? T<T>
: undefined
- Defined in lib/structures/Message.ts:365

createdAt

get createdAt(): Date
Returns Date
Inherited from Base.createdAt
- Defined in lib/structures/Base.ts:39

guild

get guild(): T extends AnyTextableGuildChannel
? Guild
: null | Guild
The guild this message is in. This will throw an error if the guild is not cached.

Returns T extends AnyTextableGuildChannel
? Guild
: null | Guild
- Defined in lib/structures/Message.ts:370

jumpLink

get jumpLink(): string
A link to this message.

Returns string
- Defined in lib/structures/Message.ts:392

Methods

createReaction

createReaction(emoji): Promise<void>
Add a reaction to this message.
Parameters
- emoji: string
  The reaction to add to the message. name:id for custom emojis, and the unicode codepoint for default emojis.
Returns Promise<void>
- Defined in lib/structures/Message.ts:400

crosspost

crosspost(): Promise<Message<T>>
Crosspost this message in an announcement channel.

Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:407

delete

delete(reason?): Promise<void>
Delete this message.
Parameters
- Optional reason: string
  The reason for deleting the message.
Returns Promise<void>
- Defined in lib/structures/Message.ts:415

deleteReaction

deleteReaction(emoji, user?): Promise<void>
Remove a reaction from this message.
Parameters
- emoji: string
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
- user: string = "@me"
  The user to remove the reaction from, @me for the current user (default).
Returns Promise<void>
- Defined in lib/structures/Message.ts:424

deleteReactions

deleteReactions(emoji?): Promise<void>
Remove all, or a specific emoji's reactions from this message.
Parameters
- Optional emoji: string
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis. Omit to remove all reactions.
Returns Promise<void>
- Defined in lib/structures/Message.ts:432

deleteWebhook

deleteWebhook(token, options): Promise<void>
Delete this message as a webhook.
Parameters
- token: string
  The token of the webhook.
- options: DeleteWebhookMessageOptions
  Options for deleting the message.
Returns Promise<void>
- Defined in lib/structures/Message.ts:441

edit

edit(options): Promise<Message<T>>
Edit this message.
Parameters
- options: EditMessageOptions
  The options for editing the message.
Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:452

editWebhook

editWebhook(token, options): Promise<Message<T>>
Edit this message as a webhook.
Parameters
- token: string
  The token of the webhook.
- options: EditWebhookMessageOptions
  The options for editing the message.
Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:461

expire

expire(): Promise<void>
End this The poll on this message now.

Returns Promise<void>
- Defined in lib/structures/Message.ts:469

getPollAnswerUsers

getPollAnswerUsers(answerID, options?): Promise<User[]>
Get the users that voted on a poll answer.
Parameters
- answerID: number
  The ID of the poll answer to get voters for.
- Optional options: GetPollAnswerUsersOptions
  The options for getting the voters.
Returns Promise<User[]>
- Defined in lib/structures/Message.ts:482

getReactions

getReactions(emoji, options?): Promise<User[]>
Get the users who reacted with a specific emoji on this message.
Parameters
- emoji: string
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
- Optional options: GetReactionsOptions
  The options for getting the reactions.
Returns Promise<User[]>
- Defined in lib/structures/Message.ts:495

inCachedGuildChannel

inCachedGuildChannel(): this is Message<AnyTextableGuildChannel>
Whether this message belongs to a cached guild channel. The only difference on using this method over a simple if statement is to easily update all the message properties typing definitions based on the channel it belongs to.

Returns this is Message<AnyTextableGuildChannel>
- Defined in lib/structures/Message.ts:500

inDirectMessageChannel

inDirectMessageChannel(): this is Message<PrivateChannel | Uncached>
Whether this message belongs to a direct message channel (PrivateChannel or uncached). The only difference on using this method over a simple if statement is to easily update all the message properties typing definitions based on the channel it belongs to.

Returns this is Message<PrivateChannel | Uncached>
- Defined in lib/structures/Message.ts:505

pin(reason?): Promise<void>
Pin this message.
Parameters
- Optional reason: string
  The reason for pinning the message.
Returns Promise<void>
- Defined in lib/structures/Message.ts:513

startThread

startThread(options): Promise<T extends AnnouncementChannel
    ? AnnouncementThreadChannel
    : T extends TextChannel
        ? PublicThreadChannel
        : never>
Create a thread from this message.
Parameters
- options: StartThreadFromMessageOptions
  The options for creating the thread.
Returns Promise<T extends AnnouncementChannel
    ? AnnouncementThreadChannel
    : T extends TextChannel
        ? PublicThreadChannel
        : never>
- Defined in lib/structures/Message.ts:522

toJSON

toJSON(): JSONMessage
Returns JSONMessage
Overrides Base.toJSON
- Defined in lib/structures/Message.ts:525

toString

toString(): string
Returns string
Inherited from Base.toString
- Defined in lib/structures/Base.ts:64

unpin

unpin(reason?): Promise<void>
Unpin this message.
Parameters
- Optional reason: string
  The reason for unpinning the message.
Returns Promise<void>
- Defined in lib/structures/Message.ts:613

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Base.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Base.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Base.getDiscordEpoch
- Defined in lib/structures/Base.ts:32

Class Message<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Message<T>

Properties

Optional activity

Optional application

applicationID

attachments

author

Optional call

channelID

client

components

content

editedTimestamp

embeds

flags

guildID

id

Optional interaction

Deprecated

Optional interactionMetadata

member

Optional mentionChannels

mentions

Optional messageReference

Optional messageSnapshots

Optional nonce

pinned

Optional poll

Optional pollResults

Optional position

reactions

Optional referencedMessage

Optional roleSubscriptionData

Optional stickerItems

Optional thread

timestamp

tts

type

Optional webhookID

Accessors

channel

Returns T extends AnyTextableChannel ? T<T> : undefined

createdAt

Returns Date

guild

Returns T extends AnyTextableGuildChannel ? Guild : null | Guild

jumpLink

Returns string

Methods

createReaction

Parameters

Returns Promise<void>

crosspost

Returns Promise<Message<T>>

delete

Parameters

Returns Promise<void>

deleteReaction

Parameters

Returns Promise<void>

deleteReactions

Parameters

Returns Promise<void>

deleteWebhook

Parameters

Returns Promise<void>

edit

Parameters

`Optional` activity

`Optional` application

`Optional` call

`Optional` interaction

`Optional` interactionMetadata

`Optional` mentionChannels

`Optional` messageReference

`Optional` messageSnapshots

`Optional` nonce

`Optional` poll

`Optional` pollResults

`Optional` position

`Optional` referencedMessage

`Optional` roleSubscriptionData

`Optional` stickerItems

`Optional` thread

`Optional` webhookID

Returns T extends AnyTextableChannel
? T<T>
: undefined

Returns T extends AnyTextableGuildChannel
? Guild
: null | Guild

Returns Promise<T extends AnnouncementChannel
? AnnouncementThreadChannel
: T extends TextChannel
? PublicThreadChannel
: never>

`Static` generateID

`Static` getCreatedAt

`Static` getDiscordEpoch