Class Message<T>

constructor

• new Message<T>(data, client, params?): Message<T>

• Type Parameters

  • T extends TextChannel<T>

  Parameters

  • data: APIChatMessage

  • client: Client

  • Optional params: {
        originalMessageID?: null | string;
    }

    • Optional originalMessageID?: null | string

  Returns Message<T>

_lastMessageID

channelID

content

createdAt

deletedAt

editedTimestamp

Optional embeds

guildID

isPrivate

isSilent

memberID

mentions

replyMessageIds

type

Optional webhookID

channel

• get channel(): T extends TextChannel
      ? T
      : undefined

• The channel this message was created in.

  Returns T extends TextChannel
      ? T
      : undefined

guild

• get guild(): T extends Guild
      ? Guild
      : null | Guild

• The guild the message is in. This will throw an error if the guild isn't cached.

  Returns T extends Guild
      ? Guild
      : null | Guild

member

• get member(): T extends Guild
      ? Member
      : undefined | Member | Promise<Member>

• Retrieve message's member.

  Make sure to await this property (getter) to still get results even if the member is not cached.

  Returns T extends Guild
      ? Member
      : undefined | Member | Promise<Member>

  Note

  The API does not provide member information, that's why you might need to await this property.

createMessage

• createMessage(options): Promise<Message<T>>

• This method is used to create a message following this message.

  Note: this method DOES NOT reply to the current message, you have to do it yourself.

  Parameters

  • options: APIMessageOptions

    Message options.

  Returns Promise<Message<T>>

createReaction

• createReaction(reaction): Promise<void>

• Add a reaction to this message.

  Parameters

  • reaction: number

    ID of a reaction/emote.

  Returns Promise<void>

delete

• delete(): Promise<void>

• This method is used to delete the current message.

  Returns Promise<void>

deleteLast

• deleteLast(): Promise<void>

• Delete the last message sent with the message itself.

  Returns Promise<void>

deleteOriginal

• deleteOriginal(): Promise<void>

• Delete the message's original response message.

  Returns Promise<void>

deleteReaction

• deleteReaction(reaction): Promise<void>

• Remove a reaction from this message.

  Parameters

  • reaction: number

    ID of a reaction/emote.

  Returns Promise<void>

edit

• edit(newMessage): Promise<Message<T>>

• This method is used to edit the current message.

  Parameters

  • newMessage: {
        content?: string;
        embeds?: APIEmbedOptions[];
    }

    New message's options

    • Optional content?: string

    • Optional embeds?: APIEmbedOptions[]

  Returns Promise<Message<T>>

editLast

• editLast(newMessage): Promise<Message<T>>

• Edit the last message sent with the message itself.

  Parameters

  • newMessage: {
        content?: string;
        embeds?: APIEmbedOptions[];
    }

    New message's options.

    • Optional content?: string

    • Optional embeds?: APIEmbedOptions[]

  Returns Promise<Message<T>>

editOriginal

• editOriginal(newMessage): Promise<Message<T>>

• Edit the message's original response message.

  Parameters

  • newMessage: {
        content?: string;
        embeds?: APIEmbedOptions[];
    }

    New message's options.

    • Optional content?: string

    • Optional embeds?: APIEmbedOptions[]

  Returns Promise<Message<T>>

pin

• pin(): Promise<void>

• Pin this message

  Returns Promise<void>

toJSON

• toJSON(): JSONMessage

• Returns JSONMessage

unpin

• unpin(): Promise<void>

• Unpin this message

  Returns Promise<void>