Skip to content

GuildEmoji

Package: @erinjs/core

Represents a custom emoji in a guild.

Constructor

NameTypeOptionalDescription
clientClientNo
dataanyNoAPI emoji from GET /guilds/{id}/emojis or guild emoji events
guildIdstringNo

Properties

NameTypeReadonlyOptionalDescription
animatedbooleanYesNo
clientClientYesNo
guildIdstringYesNo
idstringYesNo
identifierstringYesNoEmoji identifier for use in reactions: name:id
namestringNoNo
urlstringYesNoCDN URL for this emoji image.

Methods

delete() async

Delete this emoji. Requires Manage Emojis and Stickers permission.

Returns: Promise<void>

Parameters:

None


edit() async

Edit this emoji's name. Requires Manage Emojis and Stickers permission.

Returns: Promise<GuildEmoji>

Parameters:

NameTypeOptionalDescription
options{ name: string; }No

Released under the Apache-2.0 License.