Skip to content

GuildStickerManager

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

Manages a guild’s custom stickers, cached by sticker ID.

new GuildStickerManager(rest, guildId): GuildStickerManager

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

REST

string

GuildStickerManager

Manager.constructor

readonly cache: Collection<string, APISticker>

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:47

get size(): number

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

Gets cache size.

number

Number of cached values.

Manager.size

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

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

Iterates cached entries.

IterableIterator<[string, APISticker]>

Cache iterator.

Manager.[iterator]


clear(): void

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

Clears the cache.

void

Nothing.

Manager.clear


create(options): Promise<APISticker>

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

Uploads a sticker (multipart form, as Discord requires).

GuildStickerCreateOptions

Promise<APISticker>


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(stickerId, options): Promise<APISticker>

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

Edits a sticker’s name, description or tags.

string

string | null

string

string

string

Promise<APISticker>


fetch(stickerId): Promise<APISticker>

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

Fetches one sticker.

string

Promise<APISticker>


fetchAll(): Promise<APISticker[]>

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

Fetches every sticker in the guild, replacing the cache.

Promise<APISticker[]>


find(predicate): APISticker | undefined

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

Finds a cached value.

(value, key) => boolean

Predicate.

APISticker | undefined

Matching value.

Manager.find


first(): APISticker | undefined

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

Gets the first cached value.

APISticker | undefined

First value.

Manager.first


get(id): APISticker | undefined

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

Gets a cached value.

string

Cache key.

APISticker | 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(stickerId, reason?): Promise<void>

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

Deletes a sticker.

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.

APISticker

Value.

this

This manager.

Manager.set


sync(stickers): void

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

Replaces the cache with the full list from a GUILD_STICKERS_UPDATE event.

readonly APISticker[]

void


values(): APISticker[]

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

Returns cached values.

APISticker[]

Array of values.

Manager.values