Skip to content

ChannelManager

Defined in: packages/managers/src/index.ts:75

Generic cache manager.

new ChannelManager(rest, options?): ChannelManager

Defined in: packages/managers/src/index.ts:85

REST

AllowedMentions

Default allowed_mentions for sends and edits without their own.

MessageCacheOptions

Enables a bounded per-channel message cache; messages are not cached by default.

ChannelManager

Manager.constructor

readonly cache: Collection<string, Channel>

Defined in: packages/managers/src/base.ts:27

Authoritative resource state. Entries never expire: see Manager.set.

Manager.cache

get size(): number

Defined in: packages/managers/src/base.ts:105

Gets cache size.

number

Number of cached values.

Manager.size

[iterator](): IterableIterator<[string, Channel]>

Defined in: packages/managers/src/base.ts:121

Iterates cached entries.

IterableIterator<[string, Channel]>

Cache iterator.

Manager.[iterator]


addReaction(channelId, messageId, emoji): Promise<void>

Defined in: packages/managers/src/index.ts:425

string

string

string

Promise<void>


bulkDeleteMessages(channelId, messageIds, reason?): Promise<void>

Defined in: packages/managers/src/index.ts:378

Bulk-deletes messages in a channel. Duplicate IDs are ignored and a single ID falls back to a normal delete.

string

Iterable<string>

string

Promise<void>

If no IDs or more than 100 are provided, or any message is older than 14 days (Discord refuses to bulk-delete those).


cachedMessages(channelId): MessageManager | undefined

Defined in: packages/managers/src/index.ts:251

Returns the message manager for a channel only if one already exists.

string

MessageManager | undefined


clear(): void

Defined in: packages/managers/src/index.ts:651

Clears the cache.

void

Nothing.

Manager.clear


create(guildId, options): Promise<Channel>

Defined in: packages/managers/src/index.ts:254

string

ChannelCreateOptions

Promise<Channel>


createForumTag(channelId, tag, reason?): Promise<APIForumTag[]>

Defined in: packages/managers/src/index.ts:525

Adds a tag to a forum or media channel and returns the channel’s tags.

string

ForumTagInput

string

Audit-log reason.

Promise<APIForumTag[]>


createThreadFromMessage(channelId, messageId, options): Promise<Channel>

Defined in: packages/managers/src/index.ts:617

string

string

MessageThreadOptions

Promise<Channel>


createWebhook(channelId, options): Promise<APIWebhook>

Defined in: packages/managers/src/index.ts:608

Creates a webhook in a channel.

string

Name, optional avatar data URI, and audit-log reason.

string | null

string

string

Promise<APIWebhook>


crosspostMessage(channelId, messageId): Promise<Message>

Defined in: packages/managers/src/index.ts:364

string

string

Promise<Message>


delete(channelId): boolean

Defined in: packages/managers/src/index.ts:291

Evicts a channel, dropping its per-channel message manager with it. Overrides Manager.delete so cache eviction driven by a Gateway CHANNEL_DELETE/THREAD_DELETE — which calls delete rather than remove — releases the message manager and its cached messages too, instead of retaining them for the client’s lifetime.

string

boolean

Manager.delete


deleteCachedMessage(channelId, messageId): boolean

Defined in: packages/managers/src/index.ts:361

string

string

boolean


deleteGuildChannels(guildId): number

Defined in: packages/managers/src/index.ts:193

Removes every cached channel that belongs to a guild.

string

number

Number removed.


deleteMessage(channelId, messageId, reason?): Promise<void>

Defined in: packages/managers/src/index.ts:351

Deletes a message.

string

string

string

Audit-log reason (shown when deleting someone else’s message).

Promise<void>


edit(channelId, options): Promise<Channel>

Defined in: packages/managers/src/index.ts:267

string

ChannelEditOptions

Promise<Channel>


editForumTag(channelId, tagId, changes, reason?): Promise<APIForumTag[]>

Defined in: packages/managers/src/index.ts:534

Changes a forum tag and returns the channel’s tags.

string

string

Partial<ForumTagInput>

string

Promise<APIForumTag[]>


editMessage(channelId, messageId, options): Promise<Message>

Defined in: packages/managers/src/index.ts:336

string

string

MessageEditOptions

Promise<Message>


endPoll(channelId, messageId): Promise<Message>

Defined in: packages/managers/src/index.ts:204

Ends a poll now; returns the updated message.

string

string

Promise<Message>


fetch(channelId): Promise<Channel>

Defined in: packages/managers/src/index.ts:158

Fetches a channel; concurrent fetches share a request and a stale result never overwrites newer state.

string

Promise<Channel>


fetchMessage(channelId, messageId, options?): Promise<Message>

Defined in: packages/managers/src/index.ts:301

string

string

MessageFetchOptions = {}

Promise<Message>


fetchMessages(channelId, query): Promise<Message[]>

Defined in: packages/managers/src/index.ts:309

string

Iterable<string, any, any> | MessageQueryOptions

Promise<Message[]>


fetchPage(channelId, options?): Promise<{ after?: string; before?: string; hasMore: boolean; messages: Message[]; }>

Defined in: packages/managers/src/index.ts:630

Fetches a page of messages with cursor metadata.

string

Channel to fetch from.

MessageQueryOptions = {}

Page options — before, after, around, and limit (max 100).

Promise<{ after?: string; before?: string; hasMore: boolean; messages: Message[]; }>

{ messages, before, after, hasMore } — use before or after as cursors for the next page.


fetchPinnedMessages(channelId): Promise<Message[]>

Defined in: packages/managers/src/index.ts:483

Fetches the newest pinned messages (one page, up to 50, like the endpoint it replaces).

string

Promise<Message[]>


fetchPins(channelId, options?): Promise<{ hasMore: boolean; messages: Message[]; }>

Defined in: packages/managers/src/index.ts:492

Fetches pinned messages a page at a time, newest first (limit 1-50, before an ISO timestamp from the previous page).

string

string

number

Promise<{ hasMore: boolean; messages: Message[]; }>


fetchPollVoters(channelId, messageId, answerId, options?): Promise<User[]>

Defined in: packages/managers/src/index.ts:215

Fetches users who voted for one poll answer.

string

string

number

string

number

1-100 (default 25).

Promise<User[]>


fetchReactions(channelId, messageId, emoji, options?): Promise<User[]>

Defined in: packages/managers/src/index.ts:437

string

string

string

ReactionFetchOptions = {}

Promise<User[]>


find(predicate): Channel | undefined

Defined in: packages/managers/src/base.ts:117

Finds a cached value.

(value, key) => boolean

Predicate.

Channel | undefined

Matching value.

Manager.find


first(): Channel | undefined

Defined in: packages/managers/src/base.ts:109

Gets the first cached value.

Channel | undefined

First value.

Manager.first


get(id): Channel | undefined

Defined in: packages/managers/src/base.ts:36

Gets a cached value.

string

Cache key.

Channel | undefined

Cached value.

Manager.get


has(id): boolean

Defined in: packages/managers/src/base.ts:40

Checks whether a value is cached.

string

Cache key.

boolean

True when cached.

Manager.has


iterateMessages(channelId, options?): AsyncGenerator<Message, void, undefined>

Defined in: packages/managers/src/index.ts:408

Iterates a channel’s history newest-first, 100 messages per request, starting before before (or the latest message) and stopping after limit messages or at the start of the channel.

string

string

number

AsyncGenerator<Message, void, undefined>


messages(channelId): MessageManager

Defined in: packages/managers/src/index.ts:121

string

MessageManager


permissionOverwrites(channelId): PermissionOverwriteManager

Defined in: packages/managers/src/index.ts:136

Permission overwrite manager for a channel.

string

PermissionOverwriteManager


pinMessage(channelId, messageId, reason?): Promise<void>

Defined in: packages/managers/src/index.ts:585

Pins a message.

string

string

string

Audit-log reason.

Promise<void>


remove(channelId, reason?): Promise<void>

Defined in: packages/managers/src/index.ts:282

Deletes a channel (or closes a DM).

string

string

Audit-log reason.

Promise<void>


removeAllReactions(channelId, messageId): Promise<void>

Defined in: packages/managers/src/index.ts:474

string

string

Promise<void>


removeForumTag(channelId, tagId, reason?): Promise<APIForumTag[]>

Defined in: packages/managers/src/index.ts:552

Removes a forum tag and returns the channel’s remaining tags.

string

string

string

Promise<APIForumTag[]>


removeOwnReaction(channelId, messageId, emoji): Promise<void>

Defined in: packages/managers/src/index.ts:455

string

string

string

Promise<void>


removeReaction(channelId, messageId, emoji, userId): Promise<void>

Defined in: packages/managers/src/index.ts:464

string

string

string

string

Promise<void>


resolve(channelId): Promise<Channel>

Defined in: packages/managers/src/index.ts:171

string

Promise<Channel>


send(channelId, options): Promise<Message>

Defined in: packages/managers/src/index.ts:295

string

MessageCreateOptions

Promise<Message>


sendSoundboardSound(channelId, options): Promise<void>

Defined in: packages/managers/src/index.ts:241

Plays a soundboard sound in a voice channel the bot is connected to.

string

string

string

Promise<void>


set(id, value): this

Defined in: packages/managers/src/base.ts:88

Stores a resource with setWithoutTTL(), so it leaves only on an explicit delete (e.g. a Gateway *_DELETE), never through TTL.

string

Cache key.

Channel

Value.

this

This manager.

Manager.set


threads(channelId): ThreadManager

Defined in: packages/managers/src/index.ts:149

string

ThreadManager


triggerTyping(channelId): Promise<void>

Defined in: packages/managers/src/index.ts:521

Shows “the bot is typing…” for about ten seconds, or until it sends a message.

string

Promise<void>


unpinMessage(channelId, messageId, reason?): Promise<void>

Defined in: packages/managers/src/index.ts:597

Unpins a message.

string

string

string

Audit-log reason.

Promise<void>


update(channel): this

Defined in: packages/managers/src/index.ts:189

Channel

this


upsert(data): Channel

Defined in: packages/managers/src/index.ts:174

APIChannel

Channel


upsertMessage(data): Message

Defined in: packages/managers/src/index.ts:331

APIMessage

Message


values(): Channel[]

Defined in: packages/managers/src/base.ts:113

Returns cached values.

Channel[]

Array of values.

Manager.values