Class Message<T>

Represents a message.

Type Parameters

Hierarchy

Constructors

constructor

Properties

_cachedChannel _cachedGuild? activity? application? applicationID attachments author channelID client components content editedTimestamp embeds flags guildID id interaction? member mentionChannels? mentions messageReference? nonce? pinned position? reactions referencedMessage? stickerItems? thread? timestamp tts type webhookID?

Accessors

channel createdAt guild jumpLink

Methods

createReaction crosspost delete deleteReaction deleteReactions deleteWebhook edit editWebhook getReactions inCachedGuildChannel inDirectMessageChannel pin startThread toJSON toString unpin update generateID getCreatedAt getDiscordEpoch

Constructors

constructor

Properties

Private _cachedChannel

_cachedChannel: any

Private Optional _cachedGuild

_cachedGuild?: any

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:

applicationID

applicationID: null | string

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

attachments

attachments: TypedCollection<string, RawAttachment, Attachment, []>

The attachments on this message.

author

author: User

The author of this message.

channelID

channelID: string

The ID of the channel this message was created in.

client

client: Client<ClientEvents>

components

components: MessageActionRow[]

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.

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: {
    channels: string[];
    everyone: boolean;
    members: Member[];
    roles: string[];
    users: User[];
}

The mentions in this message.

Type declaration

  • channels: string[]

    The ids of the channels mentioned in this message.

  • everyone: boolean

    If @everyone/@here is mentioned in this message.

  • members: Member[]

    The members mentioned in this message.

  • roles: string[]

    The ids of the roles mentioned in this message.

  • users: User[]

    The users mentioned in this message.

Optional messageReference

messageReference?: MessageReference

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

Optional nonce

nonce?: string | number

A nonce for ensuring a message was sent.

pinned

pinned: boolean

If this message is pinned.

Optional position

position?: number

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

reactions

reactions: Record<string, 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 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
        : undefined

  • The channel this message was created in.

    Returns T extends AnyTextableChannel
        ? T
        : undefined

createdAt

  • get createdAt(): Date

  • Returns Date

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

jumpLink

  • A link to this message.

    Returns string

Methods

createReaction

  • 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>

crosspost

  • Crosspost this message in an announcement channel.

    Returns Promise<Message<T>>

delete

  • Delete this message.

    Parameters

    • Optional reason: string

      The reason for deleting the message.

    Returns Promise<void>

deleteReaction

  • 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.

    • Optional user: string

      The user to remove the reaction from, @me for the current user (default).

    Returns Promise<void>

deleteReactions

  • 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>

deleteWebhook

  • Delete this message as a webhook.

    Parameters

    Returns Promise<void>

edit

  • Edit this message.

    Parameters

    Returns Promise<Message<T>>

editWebhook

  • Edit this message as a webhook.

    Parameters

    Returns Promise<Message<T>>

getReactions

  • 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[]>

inCachedGuildChannel

  • 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>

inDirectMessageChannel

  • 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>

pin

  • Pin this message.

    Parameters

    • Optional reason: string

      The reason for pinning the message.

    Returns Promise<void>

startThread

toJSON

  • Returns JSONMessage

toString

  • Returns string

unpin

  • Unpin this message.

    Parameters

    • Optional reason: string

      The reason for unpinning the message.

    Returns Promise<void>

Protected update

  • Parameters

    Returns void

Static generateID

  • Parameters

    • Optional timestamp: number | Date

    Returns string

Static getCreatedAt

  • Parameters

    • id: string

    Returns Date

Static getDiscordEpoch

  • Parameters

    • id: string

    Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc