Documentation/detritus-client/Collections

Messagesclass

Messages Collection

On this page

Overview
Constructor1
Properties4
Accessors1
Methods10

Messages Collection

import { Collections } from 'detritus-client';

Collections.Messages;

Hierarchy

BaseCollectionMixin<K, V>BaseCollection<K, V>BaseClientCollection<string, Message>Messages

7 methods3 inheritedsrc/collections/messages.ts:46

Constructor

new Messages

src/collections/messages.ts:51

new Messages(client: ShardClient, options?: boolean | MessagesOptions)

Properties

_channelMessageIds

Map<string, Set<string>>

readonly

_guildMessageIds

Map<string, Set<string>>

readonly

client

ShardClient

Inherited from BaseClientCollection.client

enabled

boolean

Inherited from BaseClientCollection.enabled

Accessors

[toStringTag]

string

get

Overrides BaseClientCollection.[toStringTag]

Methods

_deleteIds()

src/collections/messages.ts:137

_deleteIds(messageIds?: Set<string>): Message[]

_unindex()

src/collections/messages.ts:99

_unindex(key: string, message: Message): void

clear()

src/collections/messages.ts:93

clear(): void

Overrides BaseClientCollection.clear

delete()

src/collections/messages.ts:84

delete(key: string): boolean

Overrides BaseClientCollection.delete

deleteChannel()

src/collections/messages.ts:126

deleteChannel(channelId: string): Message[]

Removes every cached message in a channel, returns them

deleteGuild()

src/collections/messages.ts:133

deleteGuild(guildId: string): Message[]

Removes every cached message in a guild (any of its channels or threads), returns them

getChannelMessages()

src/collections/messages.ts:109

getChannelMessages(channelId: string): BaseCollection<string, Message>

The cached messages of a channel, oldest first

insert()

src/collections/messages.ts:62

insert(message: Message): void

set()

src/collections/messages.ts:69

set(key: string, value: Message): this

Overrides BaseClientCollection.set

setEnabled()

src/collections/basecollection.ts:205

setEnabled(value: boolean): void

Inherited from BaseClientCollection.setEnabled