Class ChannelMessageManager

Manages all messages within a channel.

Hierarchy (View Summary)

BaseCacheManager<MessageType>
- ChannelMessageManager

Implements

ChannelMessageManager

Index

Constructors

constructor

new ChannelMessageManager(
    client: Client,
    guild: Guild,
    channel: GuildChannel,
): ChannelMessageManager
Creates a channel message manager.
Parameters
- client: Client
  The client instance.
- guild: Guild
  The guild that this message manager belongs to.
- channel: GuildChannel
  The channel that is being managed.
Returns ChannelMessageManager
Throws
Overrides BaseCacheManager.constructor
- Defined in src/managers/ChannelMessageManager.ts:39

Properties

`Static`identifier

identifier: StructureIdentifiers = ...

`Static`rules

rules: GluonCacheRuleSetStructure<any> = {}

Accessors

channel

get channel(): GuildChannel
The channel that is being managed.

Returns GuildChannel
Implementation of ChannelMessageManagerType.channel
- Defined in src/managers/ChannelMessageManager.ts:86

guild

get guild(): Guild
The guild that this message manager belongs to.

Returns Guild
Implementation of ChannelMessageManagerType.guild
- Defined in src/managers/ChannelMessageManager.ts:76

size

get size(): number
Returns the size of the cache.

Returns number
Implementation of ChannelMessageManagerType.size
Inherited from BaseCacheManager.size
- Defined in src/managers/BaseCacheManager.ts:303

Methods

_intervalCallback

_intervalCallback(): { i: StructureIdentifiers }
The callback for expiring buckets.

Returns { i: StructureIdentifiers }
Method
Implementation of ChannelMessageManagerType._intervalCallback
Inherited from BaseCacheManager._intervalCallback
- Defined in src/managers/BaseCacheManager.ts:251

#_callFetches

"#_callFetches"(id: string): Promise<null | Message>
Calls all the custom fetches.
Parameters
- id: string
  The ID to fetch.
Returns Promise<null | Message>
Method
Async
Inherited from BaseCacheManager.#_callFetches
- Defined in src/managers/BaseCacheManager.ts:285

#_callRules

"#_callRules"(value: unknown): void
Calls the rules on a value.
Parameters
- value: unknown
  The value to call the rules on.
Returns void
Method
Inherited from BaseCacheManager.#_callRules
- Defined in src/managers/BaseCacheManager.ts:268

#addToExpiryBucket

"#addToExpiryBucket"(key: string, expiry: number): void
Adds a key to the expiry bucket.
Parameters
- key: string
  The key to add to the expiry bucket.
- expiry: number
  The expiry time in seconds.
Returns void
Method
Inherited from BaseCacheManager.#addToExpiryBucket
- Defined in src/managers/BaseCacheManager.ts:158

#clearStaleBuckets

"#clearStaleBuckets"(): void
Clears stale buckets.

Returns void
Method
Inherited from BaseCacheManager.#clearStaleBuckets
- Defined in src/managers/BaseCacheManager.ts:195

clear

clear(): void
Clears the cache.

Returns void
Method
Implementation of ChannelMessageManagerType.clear
Inherited from BaseCacheManager.clear
- Defined in src/managers/BaseCacheManager.ts:241

delete

delete(key: string): boolean
Deletes a key from the cache.
Parameters
- key: string
  The key to delete.
Returns boolean
Whether the key was deleted or not.

Method
Implementation of ChannelMessageManagerType.delete
Inherited from BaseCacheManager.delete
- Defined in src/managers/BaseCacheManager.ts:224

expireBucket

expireBucket(bucket: string): void
Expires a bucket.
Parameters
- bucket: string
  The bucket to expire.
Returns void
Method
Inherited from BaseCacheManager.expireBucket
- Defined in src/managers/BaseCacheManager.ts:175

fetch

fetch(
    options:
        | string
        | { after?: string; around?: string; before?: string; limit?: number },
): Promise<Message | Message[]>
Parameters
- options: string | { after?: string; around?: string; before?: string; limit?: number }
Returns Promise<Message | Message[]>
Implementation of ChannelMessageManagerType.fetch
- Defined in src/managers/ChannelMessageManager.ts:110

fetchFromRules

fetchFromRules(key: string): Promise<null | Message>
Fetches a message from the cache or from the rules.
Parameters
- key: string
  The ID of the message to fetch.
Returns Promise<null | Message>
Async
Method
Implementation of ChannelMessageManagerType.fetchFromRules
Overrides BaseCacheManager.fetchFromRules
- Defined in src/managers/ChannelMessageManager.ts:102

fetchPinned

fetchPinned(): Promise<Message[]>
Fetches all the pinned messages that belong to the channel.

Returns Promise<Message[]>
Async
Method
Implementation of ChannelMessageManagerType.fetchPinned
- Defined in src/managers/ChannelMessageManager.ts:163

fetchWithRules

fetchWithRules(key: string): Promise<null | Message>
Fetches a value from the cache or from the rules cache.
Parameters
- key: string
  The key to fetch.
Returns Promise<null | Message>
The fetched value.

Method
Async
Throws
Implementation of ChannelMessageManagerType.fetchWithRules
Overrides BaseCacheManager.fetchWithRules
- Defined in src/managers/ChannelMessageManager.ts:106

flagForDeletion

flagForDeletion(key: string): null | Message
Parameters
- key: string
Returns null | Message
Implementation of ChannelMessageManagerType.flagForDeletion
Inherited from BaseCacheManager.flagForDeletion
- Defined in src/managers/BaseCacheManager.ts:228

forEach

forEach(callbackfn: unknown): void
Calls a function on each item in the cache.
Parameters
- callbackfn: unknown
Returns void
Method
Implementation of ChannelMessageManagerType.forEach
Inherited from BaseCacheManager.forEach
- Defined in src/managers/BaseCacheManager.ts:314

get

get(key: string): null | Message
Gets a value from the cache.
Parameters
- key: string
  The key to get.
Returns null | Message
The value from the cache.

Method
Throws
Implementation of ChannelMessageManagerType.get
Overrides BaseCacheManager.get
- Defined in src/managers/ChannelMessageManager.ts:90

has

has(key: string): boolean
Checks if a key exists in the cache.
Parameters
- key: string
  The key to check.
Returns boolean
Whether the key exists or not.

Method
Throws
Implementation of ChannelMessageManagerType.has
Inherited from BaseCacheManager.has
- Defined in src/managers/BaseCacheManager.ts:328

map

map(
    callbackfn: (
        value: [string, Message],
        index: number,
        array: [string, Message][],
    ) => unknown,
): Message[]
Parameters
- callbackfn: (value: [string, Message], index: number, array: [string, Message][]) => unknown
Returns Message[]
Implementation of ChannelMessageManagerType.map
Inherited from BaseCacheManager.map
- Defined in src/managers/BaseCacheManager.ts:332

set

set(id: string, message: Message): void
Adds a message to the cache.
Parameters
- id: string
  The ID of the message to cache.
- message: Message
  The message to cache.
Returns void
Method
Throws
Implementation of ChannelMessageManagerType.set
Overrides BaseCacheManager.set
- Defined in src/managers/ChannelMessageManager.ts:189

toJSON

toJSON(format?: JsonTypes): any[]
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns any[]
Method
Implementation of ChannelMessageManagerType.toJSON
Inherited from BaseCacheManager.toJSON
- Defined in src/managers/BaseCacheManager.ts:350

`Static`fetchMessage

fetchMessage(
    client: Client,
    guildId: string,
    channelId: string,
    messageId: string,
): Promise<Message>
Parameters
- client: Client
- guildId: string
- channelId: string
- messageId: string
Returns Promise<Message>
- Defined in src/managers/ChannelMessageManager.ts:273

`Static`fetchMessages

fetchMessages(
    client: Client,
    guildId: string,
    channelId: string,
    options?: {
        after?: string;
        around?: string;
        before?: string;
        limit?: number;
    },
): Promise<Message[]>
Fetches a collection of messages from the channel.
Parameters
- client: Client
  The client instance.
- guildId: string
  The ID of the guild.
- channelId: string
  The ID of the channel.
- options: { after?: string; around?: string; before?: string; limit?: number } = {}
  The options for fetching messages.
  - Optionalafter?: string
    The ID of the message to fetch messages after.
  - Optionalaround?: string
    The ID of the message to fetch messages around.
  - Optionalbefore?: string
    The ID of the message to fetch messages before.
  - Optionallimit?: number
    The maximum number of messages to fetch.
Returns Promise<Message[]>
Async
Static
Method
Throws
- Defined in src/managers/ChannelMessageManager.ts:344

`Static`getCacheManager

getCacheManager(
    client: Client,
    guildId: string,
    channelId: string,
): ChannelMessageManager
Returns the cache manager.
Parameters
- client: Client
  The client instance.
- guildId: string
  The ID of the guild.
- channelId: string
  The ID of the channel.
Returns ChannelMessageManager
Static
Method
Throws
- Defined in src/managers/ChannelMessageManager.ts:206

`Static`getMessage

getMessage(
    client: Client,
    guildId: string,
    channelId: string,
    messageId: string,
): null | Message
Gets a message from the cache.
Parameters
- client: Client
  The client instance.
- guildId: string
  The ID of the guild.
- channelId: string
  The ID of the channel.
- messageId: string
  The ID of the message.
Returns null | Message
Static
Method
Throws
- Defined in src/managers/ChannelMessageManager.ts:251

`Static`purgeChannelMessages

purgeChannelMessages(
    client: Client,
    guildId: string,
    channelId: string,
    messages: string[],
    __namedParameters?: { reason?: string },
): Promise<void>
Bulk deletes channel messages.
Parameters
- client: Client
  The client instance.
- guildId: string
- channelId: string
  The id of the channel to purge messages in.
- messages: string[]
  An array of message ids to delete.
- __namedParameters: { reason?: string } = {}
Returns Promise<void>
Method
Async
Throws
Static
- Defined in src/managers/ChannelMessageManager.ts:492

Class ChannelMessageManager

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ChannelMessageManager

Throws

Properties

Staticidentifier

Staticrules

Accessors

channel

Returns GuildChannel

guild

Returns Guild

size

Returns number

Methods

_intervalCallback

Returns { i: StructureIdentifiers }

Method

#_callFetches

Parameters

Returns Promise<null | Message>

Method

Async

#_callRules

Parameters

Returns void

Method

#addToExpiryBucket

Parameters

Returns void

Method

#clearStaleBuckets

Returns void

Method

clear

Returns void

Method

delete

Parameters

Returns boolean

Method

expireBucket

Parameters

Returns void

Method

fetch

Parameters

Returns Promise<Message | Message[]>

fetchFromRules

Parameters

Returns Promise<null | Message>

Async

Method

fetchPinned

Returns Promise<Message[]>

Async

Method

fetchWithRules

Parameters

Returns Promise<null | Message>

Method

Async

Throws

flagForDeletion

Parameters

Returns null | Message

forEach

Parameters

Returns void

Method

get

`Static`identifier

`Static`rules

`Static`fetchMessage

`Static`fetchMessages

`Optional`after?: string

`Optional`around?: string

`Optional`before?: string

`Optional`limit?: number

`Static`getCacheManager

`Static`getMessage

`Static`purgeChannelMessages