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<K, 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

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

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.

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.

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

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(idOrInstance):Holds

Resolves a data entry to a data Object.

Returns

An instance from this Manager

Name	Type	Optional	Description
idOrInstance	Holds	No	The id or instance of something in this Manager

resolveId(idOrInstance):K

Resolves a data entry to an instance id.

Returns

Name	Type	Optional	Description
idOrInstance	K \| Holds	No	The id or instance of something in this Manager

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<K, Holds>