Skip to content

GuildSoundboardManager

Defined in: packages/managers/src/advanced.ts:146

Manages a guild’s soundboard sounds, cached by sound ID.

new GuildSoundboardManager(rest, guildId): GuildSoundboardManager

Defined in: packages/managers/src/advanced.ts:153

REST

string

GuildSoundboardManager

Manager.constructor

readonly cache: Collection<string, APISoundboardSound>

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

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

Manager.cache


readonly guildId: string

Defined in: packages/managers/src/advanced.ts:151

get size(): number

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

Gets cache size.

number

Number of cached values.

Manager.size

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

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

Iterates cached entries.

IterableIterator<[string, APISoundboardSound]>

Cache iterator.

Manager.[iterator]


clear(): void

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

Clears the cache.

void

Nothing.

Manager.clear


create(options): Promise<APISoundboardSound>

Defined in: packages/managers/src/advanced.ts:183

Creates a sound.

SoundboardSoundCreateOptions

Promise<APISoundboardSound>


delete(id): boolean

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

Deletes a cached value.

string

Cache key.

boolean

True when deleted.

Manager.delete


edit(soundId, options): Promise<APISoundboardSound>

Defined in: packages/managers/src/advanced.ts:207

Edits a sound’s name, volume or emoji.

string

string | null

string | null

string

string

number | null

Promise<APISoundboardSound>


fetch(soundId): Promise<APISoundboardSound>

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

Fetches one sound.

string

Promise<APISoundboardSound>


fetchAll(): Promise<APISoundboardSound[]>

Defined in: packages/managers/src/advanced.ts:165

Fetches every soundboard sound in the guild, replacing the cache.

Promise<APISoundboardSound[]>


find(predicate): APISoundboardSound | undefined

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

Finds a cached value.

(value, key) => boolean

Predicate.

APISoundboardSound | undefined

Matching value.

Manager.find


first(): APISoundboardSound | undefined

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

Gets the first cached value.

APISoundboardSound | undefined

First value.

Manager.first


get(id): APISoundboardSound | undefined

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

Gets a cached value.

string

Cache key.

APISoundboardSound | 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


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

Defined in: packages/managers/src/advanced.ts:232

Deletes a sound.

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.

APISoundboardSound

Value.

this

This manager.

Manager.set


values(): APISoundboardSound[]

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

Returns cached values.

APISoundboardSound[]

Array of values.

Manager.values