GuildStickerManager
Defined in: packages/managers/src/advanced.ts:45
Manages a guild’s custom stickers, cached by sticker ID.
Extends
Section titled “Extends”Manager<string,APISticker>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GuildStickerManager(
rest,guildId):GuildStickerManager
Defined in: packages/managers/src/advanced.ts:49
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”GuildStickerManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlycache:Collection<string,APISticker>
Defined in: packages/managers/src/base.ts:27
Authoritative resource state. Entries never expire: see Manager.set.
Inherited from
Section titled “Inherited from”guildId
Section titled “guildId”
readonlyguildId:string
Defined in: packages/managers/src/advanced.ts:47
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: packages/managers/src/base.ts:105
Gets cache size.
Returns
Section titled “Returns”number
Number of cached values.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<[string,APISticker]>
Defined in: packages/managers/src/base.ts:121
Iterates cached entries.
Returns
Section titled “Returns”IterableIterator<[string, APISticker]>
Cache iterator.
Inherited from
Section titled “Inherited from”clear()
Section titled “clear()”clear():
void
Defined in: packages/managers/src/base.ts:101
Clears the cache.
Returns
Section titled “Returns”void
Nothing.
Inherited from
Section titled “Inherited from”create()
Section titled “create()”create(
options):Promise<APISticker>
Defined in: packages/managers/src/advanced.ts:79
Uploads a sticker (multipart form, as Discord requires).
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<APISticker>
delete()
Section titled “delete()”delete(
id):boolean
Defined in: packages/managers/src/base.ts:96
Deletes a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when deleted.
Inherited from
Section titled “Inherited from”edit()
Section titled “edit()”edit(
stickerId,options):Promise<APISticker>
Defined in: packages/managers/src/advanced.ts:97
Edits a sticker’s name, description or tags.
Parameters
Section titled “Parameters”stickerId
Section titled “stickerId”string
options
Section titled “options”description?
Section titled “description?”string | null
string
reason?
Section titled “reason?”string
string
Returns
Section titled “Returns”Promise<APISticker>
fetch()
Section titled “fetch()”fetch(
stickerId):Promise<APISticker>
Defined in: packages/managers/src/advanced.ts:70
Fetches one sticker.
Parameters
Section titled “Parameters”stickerId
Section titled “stickerId”string
Returns
Section titled “Returns”Promise<APISticker>
fetchAll()
Section titled “fetchAll()”fetchAll():
Promise<APISticker[]>
Defined in: packages/managers/src/advanced.ts:61
Fetches every sticker in the guild, replacing the cache.
Returns
Section titled “Returns”Promise<APISticker[]>
find()
Section titled “find()”find(
predicate):APISticker|undefined
Defined in: packages/managers/src/base.ts:117
Finds a cached value.
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, key) => boolean
Predicate.
Returns
Section titled “Returns”APISticker | undefined
Matching value.
Inherited from
Section titled “Inherited from”first()
Section titled “first()”first():
APISticker|undefined
Defined in: packages/managers/src/base.ts:109
Gets the first cached value.
Returns
Section titled “Returns”APISticker | undefined
First value.
Inherited from
Section titled “Inherited from”get(
id):APISticker|undefined
Defined in: packages/managers/src/base.ts:36
Gets a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”APISticker | undefined
Cached value.
Inherited from
Section titled “Inherited from”has(
id):boolean
Defined in: packages/managers/src/base.ts:40
Checks whether a value is cached.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when cached.
Inherited from
Section titled “Inherited from”remove()
Section titled “remove()”remove(
stickerId,reason?):Promise<void>
Defined in: packages/managers/src/advanced.ts:117
Deletes a sticker.
Parameters
Section titled “Parameters”stickerId
Section titled “stickerId”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”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.
Parameters
Section titled “Parameters”string
Cache key.
Value.
Returns
Section titled “Returns”this
This manager.
Inherited from
Section titled “Inherited from”sync()
Section titled “sync()”sync(
stickers):void
Defined in: packages/managers/src/advanced.ts:125
Replaces the cache with the full list from a GUILD_STICKERS_UPDATE event.
Parameters
Section titled “Parameters”stickers
Section titled “stickers”readonly APISticker[]
Returns
Section titled “Returns”void
values()
Section titled “values()”values():
APISticker[]
Defined in: packages/managers/src/base.ts:113
Returns cached values.
Returns
Section titled “Returns”Array of values.