Class

GuildEmoji

Represents a custom emoji in a guild.

Extends Base

Constructor

new GuildEmoji(client: Client, data: APIEmoji & { guild_id?: string }, guildId: string)
client
Client
data
APIEmoji & { guild_id?: string }API emoji from GET /guilds/{id}/emojis or guild emoji events
guildId
string

Properties

NameTypeDescription
animatedread-onlyboolean
clientread-onlyClient
createdAtread-onlyDateDate when this emoji was created, derived from its snowflake ID.
createdTimestampread-onlynumberUnix timestamp (ms) when this emoji was created, derived from its snowflake ID.
guildIdread-onlystring
idread-onlystring
identifierread-onlystringEmoji identifier for use in reactions: name:id (or a:name:id when animated).
namestring
urlread-onlystringCDN URL for this emoji image.

Methods

.delete()

Promise<void>

Delete this emoji. Requires Manage Emojis and Stickers permission.

await emoji.delete();

.edit(options)

options: { name: string; }Promise<GuildEmoji>

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

await emoji.edit(options);

.toString()

string

Renders this emoji for use in message content: <:name:id> (or <a:name:id> when animated).

emoji.toString();