Class

GuildSticker

Represents a custom sticker in a guild.

Extends Base

Constructor

new GuildSticker(client: Client, data: APISticker & { guild_id?: string }, guildId: string)
client
Client
data
APISticker & { guild_id?: string }API sticker from GET /guilds/{id}/stickers or guild sticker events
guildId
string

Properties

NameTypeDescription
animatedread-onlyboolean
clientread-onlyClient
createdAtread-onlyDateDate when this sticker was created, derived from its snowflake ID.
createdTimestampread-onlynumberUnix timestamp (ms) when this sticker was created, derived from its snowflake ID.
descriptionstring
guildIdread-onlystring
idread-onlystring
namestring
nsfwbooleanWhether this sticker is classified as NSFW
tagsstring[]
urlread-onlystringCDN URL for this sticker image.

Methods

.delete()

Promise<void>

Delete this sticker. Requires Manage Emojis and Stickers permission.

await sticker.delete();

.edit(options)

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

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

await sticker.edit(options);