Class

GuildSticker

Represents a custom sticker in a guild.

Extends Base

Constructor

new GuildSticker(client: Client, data: APISticker & { guild_id?: string }, guildId: string)
ParamTypeDescription
clientClient
dataAPISticker & { guild_id?: string }

API sticker from GET /guilds/{id}/stickers or guild sticker events

guildIdstring

Properties

animated: boolean (readonly)
client: Client (readonly)
description: string
guildId: string (readonly)
id: string (readonly)
name: string
nsfw: boolean

Whether this sticker is classified as NSFW

tags: string[] (readonly)
url: string (readonly)

CDN URL for this sticker image.

Methods

delete(): Promise<void>

Delete this sticker. Requires Manage Emojis and Stickers permission.

edit(options: { name?: string; description?: string; }): Promise<GuildSticker>

Edit this sticker's name and/or description. Requires Manage Emojis and Stickers permission.

ParamTypeDescription
options{ name?: string; description?: string; }