Class Message

Message component, with all its methods and declarations.

Hierarchy

Base
- Message

Index

Constructors

constructor

new Message(data: APIChatMessage, client: Client, params?: {
oldMessage?: object;
originalMessageID?: null | string;
}): Message
Parameters
- data: APIChatMessage
- client: Client
- Optional params: {
  oldMessage?: object;
  originalMessageID?: null | string;
  }
  - Optional oldMessage?: object
  - Optional originalMessageID?: null | string
Returns Message
Overrides Base.constructor
- Defined in lib/structures/Message.ts:54

Properties

`Readonly` _createdAt

_createdAt: number

Timestamp (unix epoch time) of the message's creation.

`Readonly` _deletedAt

_deletedAt: null | number

Timestamp (unix epoch time) of the message's deletion.

_lastMessageID

_lastMessageID: null | string

ID of the last message created with the message itself.

`Readonly` _updatedAt

_updatedAt: null | number

Timestamp (unix epoch time) of the last message update/edition.

channelID

channelID: string

ID of the channel on which the message was sent.

content

content: undefined | string

Content of the message.

`Optional` embeds

embeds?: APIEmbedOptions[] | []

Array of message embed.

guildID

guildID: null | string

ID of the server on which the message was sent.

id

id: string | number

Item ID

isPrivate

isPrivate: undefined | boolean

isSilent

isSilent: undefined | boolean

memberID

memberID: string

ID of the message author.

mentions

mentions: APIMentions

object containing all mentioned users.

oldContent

oldContent: null | string

Old content of the message, if edited.

replyMessageIds

replyMessageIds: string[]

The IDs of the message replied by the message.

type

type: string

Message type.

`Optional` webhookID

webhookID?: null | string

ID of the webhook used to send this message. (if sent by a webhook)

Accessors

channel

get channel(): Promise<Channel>
Getter used to get the message's channel

Note: this returns a promise, make sure to await it before.

Returns Promise<Channel>
- Defined in lib/structures/Message.ts:124

createdAt

get createdAt(): Date
string representation of the _createdAt timestamp.

Returns Date
- Defined in lib/structures/Message.ts:80

deletedAt

get deletedAt(): void | Date
string representation of the _deletedAt timestamp.

Returns void | Date
- Defined in lib/structures/Message.ts:90

guild

get guild(): undefined | Guild | Promise<Guild>
Getter used to get the message's guild

Note: this returns a promise, make sure to await it before.

Returns undefined | Guild | Promise<Guild>
- Defined in lib/structures/Message.ts:115

member

get member(): undefined | User | Member | Promise<Member>
Retrieve message's member, if cached.

Note: this getter can output: Member, User, Promise or undefined.

Returns undefined | User | Member | Promise<Member>
- Defined in lib/structures/Message.ts:98

updatedAt

get updatedAt(): void | Date
string representation of the _updatedAt timestamp.

Returns void | Date
- Defined in lib/structures/Message.ts:85

Methods

createMessage

createMessage(options: APIMessageOptions): Promise<Message>
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>
- Defined in lib/structures/Message.ts:143

createReaction

createReaction(reaction: number): Promise<void>
Add a reaction to this message.
Parameters
- reaction: number
  
  ID of a reaction/emote.
Returns Promise<void>
- Defined in lib/structures/Message.ts:197

delete

delete(): Promise<void>
This method is used to delete the current message.

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

deleteLastMessage

deleteLastMessage(): Promise<void>
Delete the last message sent with the message itself.

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

deleteOriginalMessage

deleteOriginalMessage(): Promise<void>
Delete the message's original response message.

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

deleteReaction

deleteReaction(reaction: number): Promise<void>
Remove a reaction from this message.
Parameters
- reaction: number
  
  ID of a reaction/emote.
Returns Promise<void>
- Defined in lib/structures/Message.ts:204

edit

edit(newMessage: {
content?: string;
embeds?: APIEmbedOptions[];
}): Promise<Message>
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>
- Defined in lib/structures/Message.ts:156

editLastMessage

editLastMessage(newMessage: {
content?: string;
embeds?: APIEmbedOptions[];
}): Promise<Message>
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>
- Defined in lib/structures/Message.ts:169

editOriginalMessage

editOriginalMessage(newMessage: {
content?: string;
embeds?: APIEmbedOptions[];
}): Promise<Message>
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>
- Defined in lib/structures/Message.ts:183

Class Message

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: APIChatMessage

client: Client

Optional params: { oldMessage?: object; originalMessageID?: null | string; }

Optional oldMessage?: object

Optional originalMessageID?: null | string

Returns Message

Properties

Readonly _createdAt

Readonly _deletedAt

_lastMessageID

Readonly _updatedAt

channelID

content

Optional embeds

guildID

id

isPrivate

isSilent

memberID

mentions

oldContent

replyMessageIds

type

Optional webhookID

Accessors

channel

Returns Promise<Channel>

createdAt

Returns Date

deletedAt

Returns void | Date

guild

Returns undefined | Guild | Promise<Guild>

member

Returns undefined | User | Member | Promise<Member>

updatedAt

Returns void | Date

Methods

createMessage

Parameters

options: APIMessageOptions

Returns Promise<Message>

createReaction

Parameters

reaction: number

Returns Promise<void>

delete

Returns Promise<void>

deleteLastMessage

Returns Promise<void>

deleteOriginalMessage

Returns Promise<void>

deleteReaction

Parameters

reaction: number

Returns Promise<void>

edit

Parameters

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

Optional content?: string

Optional embeds?: APIEmbedOptions[]

Returns Promise<Message>

editLastMessage

Parameters

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

Optional content?: string

Optional embeds?: APIEmbedOptions[]

Returns Promise<Message>

editOriginalMessage

Parameters

`Optional` params: {
oldMessage?: object;
originalMessageID?: null | string;
}

`Optional` oldMessage?: object

`Optional` originalMessageID?: null | string

`Readonly` _createdAt

`Readonly` _deletedAt

`Readonly` _updatedAt

`Optional` embeds

`Optional` webhookID

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

`Optional` content?: string

`Optional` embeds?: APIEmbedOptions[]

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

`Optional` content?: string

`Optional` embeds?: APIEmbedOptions[]

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

`Optional` content?: string

`Optional` embeds?: APIEmbedOptions[]