Skip to content

GuildSticker

Package: @erinjs/core

Represents a custom sticker in a guild.

Constructor

NameTypeOptionalDescription
clientClientNo
dataanyNoAPI sticker from GET /guilds/{id}/stickers or guild sticker events
guildIdstringNo

Properties

NameTypeReadonlyOptionalDescription
animatedbooleanYesNo
clientClientYesNo
descriptionstringNoNo
guildIdstringYesNo
idstringYesNo
namestringNoNo
tagsstring[]YesNo
urlstringYesNoCDN URL for this sticker image.

Methods

delete() async

Delete this sticker. Requires Manage Emojis and Stickers permission.

Returns: Promise<void>

Parameters:

None


edit() async

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

Returns: Promise<GuildSticker>

Parameters:

NameTypeOptionalDescription
options{ name?: string; description?: string; }No

Released under the Apache-2.0 License.