Preview environment

class GuildStickerManager

export class GuildStickerManager extends CachedManager<Snowflake, Sticker, StickerResolvable>

Manages API methods for Guild Stickers and stores their cache.

readonly
cache : Collection<Key, Holds>

The cache of items for this manager.

Inherited from: DataManager

readonly
client : Client

The client that instantiated this Manager

Inherited from: BaseManager

guild : Guild

The guild this manager belongs to

readonly
holds : Constructable<Holds>

The data structure belonging to this manager.

Inherited from: DataManager

create(
options: GuildStickerCreateOptions
) : Promise<Sticker>

Creates a new custom sticker in the guild.

Examples:
// Create a new sticker from a URL
guild.stickers.create({ file: 'https://i.imgur.com/w3duR07.png', name: 'rip', tags: 'headstone' })
  .then(sticker => console.log(`Created new sticker with name ${sticker.name}!`))
  .catch(console.error);
// Create a new sticker from a file on your computer
guild.stickers.create({ file: './memes/banana.png', name: 'banana', tags: 'banana' })
  .then(sticker => console.log(`Created new sticker with name ${sticker.name}!`))
  .catch(console.error);

Returns: The created sticker

delete(
sticker: StickerResolvable
reason?: string
) : Promise<void>

Deletes a sticker.

edit(
sticker: StickerResolvable
options?: GuildStickerEditOptions
) : Promise<Sticker>

Edits a sticker.

fetch(
id: Snowflake
options?: BaseFetchOptions
) : Promise<Sticker>

Obtains one or more stickers from Discord, or the sticker cache if they're already available.

Examples:
// Fetch all stickers from the guild
message.guild.stickers.fetch()
  .then(stickers => console.log(`There are ${stickers.size} stickers.`))
  .catch(console.error);
// Fetch a single sticker
message.guild.stickers.fetch('222078108977594368')
  .then(sticker => console.log(`The sticker name is: ${sticker.name}`))
  .catch(console.error);

fetchUser(
sticker: StickerResolvable
) : Promise<User | null>

Fetches the user who uploaded this sticker, if this is a guild sticker.

resolve(
sticker: StickerResolvable
) : Sticker | null

Resolves a StickerResolvable to a Sticker object.

resolveId(
sticker: StickerResolvable
) : Snowflake | null

Resolves a StickerResolvable to a Sticker id string.

valueOf() : Collection<Key, Holds>

Inherited from: DataManager