discord.js | MessageManager

Search...

Abstract

MessageManager

export abstract class MessageManager<InGuild extends boolean = boolean> extends CachedManager<Snowflake, Message<InGuild>, MessageResolvable>

export abstract class MessageManager<InGuild extends boolean = boolean> extends CachedManager<Snowflake, Message<InGuild>, MessageResolvable>

Manages API methods for Messages and holds their cache.

Extends

CachedManager<Snowflake, Message<InGuild>, MessageResolvable>

Name	Constraints	Optional	Default	Description
InGuild	boolean	Yes	boolean	None

constructor(channel, iterable?)

Constructs a new instance of the MessageManager class

Name	Type	Optional	Description
channel	TextBasedChannel	No	None
iterable	Iterable<RawMessageData>	Yes	None

Readonly

cache:Collection<Key, Holds>

The cache of items for this manager.

Inherited from DataManager

channel:TextBasedChannel

The channel that the messages belong to

Readonly

client:Client

The client that instantiated this Manager

Inherited from BaseManager

Readonly

holds:Constructable<Holds>

The data structure belonging to this manager.

Inherited from DataManager

crosspost(message):Promise<Message>

Publishes a message in an announcement channel to all channels following it, even if it's not cached.

Name	Type	Optional	Description
message	MessageResolvable	No	The message to publish

delete(message):Promise<void>

Deletes a message, even if it's not cached.

Name	Type	Optional	Description
message	MessageResolvable	No	The message to delete

edit(message, options):Promise<Message<InGuild>>

Edits a message, even if it's not cached.

Name	Type	Optional	Description
message	MessageResolvable	No	The message to edit
options	string \| MessagePayload \| MessageEditOptions	No	The options to edit the message

endPoll(messageId):Promise<Message>

Ends a poll.

Name	Type	Optional	Description
messageId	Snowflake	No	The id of the message

fetch(options):Promise<Message<InGuild>>

Fetches message(s) from a channel. The returned Collection does not contain reaction users of the messages if they were not cached. Those need to be fetched separately in such a case.

Example

// Fetch a message
channel.messages.fetch('99539446449315840')
  .then(message => console.log(message.content))
  .catch(console.error);

// Fetch a message
channel.messages.fetch('99539446449315840')
  .then(message => console.log(message.content))
  .catch(console.error);

Example

// Fetch a maximum of 10 messages without caching
channel.messages.fetch({ limit: 10, cache: false })
  .then(messages => console.log(`Received ${messages.size} messages`))
  .catch(console.error);

// Fetch a maximum of 10 messages without caching
channel.messages.fetch({ limit: 10, cache: false })
  .then(messages => console.log(`Received ${messages.size} messages`))
  .catch(console.error);

Example

// Fetch a maximum of 10 messages without caching around a message id
channel.messages.fetch({ limit: 10, cache: false, around: '99539446449315840' })
  .then(messages => console.log(`Received ${messages.size} messages`))
  .catch(console.error);

// Fetch a maximum of 10 messages without caching around a message id
channel.messages.fetch({ limit: 10, cache: false, around: '99539446449315840' })
  .then(messages => console.log(`Received ${messages.size} messages`))
  .catch(console.error);

Example

// Fetch messages and filter by a user id
channel.messages.fetch()
  .then(messages => console.log(`${messages.filter(message =>
         message.author.id === '84484653687267328').size} messages`))
  .catch(console.error);

// Fetch messages and filter by a user id
channel.messages.fetch()
  .then(messages => console.log(`${messages.filter(message =>
         message.author.id === '84484653687267328').size} messages`))
  .catch(console.error);

Name	Type	Optional	Description
options	MessageResolvable \| FetchMessageOptions	No	Options for fetching message(s)

fetchPinned(cache?):Promise<Collection<Snowflake, Message<InGuild>>>

Fetches the pinned messages of this channel and returns a collection of them. The returned Collection does not contain any reaction data of the messages. Those need to be fetched separately.

Example

// Get pinned messages
channel.messages.fetchPinned()
  .then(messages => console.log(`Received ${messages.size} messages`))
  .catch(console.error);

// Get pinned messages
channel.messages.fetchPinned()
  .then(messages => console.log(`Received ${messages.size} messages`))
  .catch(console.error);

Name	Type	Optional	Description
cache	boolean	Yes	Whether to cache the message(s)

fetchPollAnswerVoters(options):Promise<Collection<Snowflake, User>>

Fetches the users that voted for a poll answer.

Name	Type	Optional	Description
options	FetchPollAnswerVotersOptions	No	The options for fetching the poll answer voters

pin(message, reason?):Promise<void>

Pins a message to the channel's pinned messages, even if it's not cached.

Name	Type	Optional	Description
message	MessageResolvable	No	The message to pin
reason	string	Yes	Reason for pinning

react(message, emoji):Promise<void>

Adds a reaction to a message, even if it's not cached.

Name	Type	Optional	Description
message	MessageResolvable	No	The message to react to
emoji	EmojiIdentifierResolvable	No	The emoji to react with

resolve(message):Message | null

Resolves a MessageResolvable to a Message object.

Name	Type	Optional	Description
message	MessageResolvable	No	The message resolvable to resolve

resolveId(message):Snowflake | null

Resolves a MessageResolvable to a Message id.

Name	Type	Optional	Description
message	MessageResolvable	No	The message resolvable to resolve

unpin(message, reason?):Promise<void>

Unpins a message from the channel's pinned messages, even if it's not cached.

Name	Type	Optional	Description
message	MessageResolvable	No	The message to unpin
reason	string	Yes	Reason for unpinning

valueOf():Collection<Key, Holds>