Preview environment

class GuildEmoji

export class GuildEmoji extends BaseGuildEmoji

Represents a custom emoji.

animated : boolean | null

Whether or not the emoji is animated

Inherited from: Emoji

author : User | null

The user who created this emoji

available : boolean | null

Whether this emoji is available

Inherited from: BaseGuildEmoji

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
createdAt : Date

The time the emoji was created at, or null if unicode

Inherited from: BaseGuildEmoji

readonly
createdTimestamp : number

The timestamp the emoji was created at, or null if unicode

Inherited from: BaseGuildEmoji

readonly
deletable : boolean

Whether the emoji is deletable by the client user

guild : Guild

The guild this emoji is part of

id : Snowflake

The emoji's id

Inherited from: BaseGuildEmoji

readonly
identifier : string

The identifier of this emoji, used for message reactions

Inherited from: Emoji

managed : boolean | null

Whether this emoji is managed by an external service

Inherited from: BaseGuildEmoji

name : string | null

The emoji's name

Inherited from: Emoji

requiresColons : boolean | null

Whether or not this emoji requires colons surrounding it

Inherited from: BaseGuildEmoji

readonly
roles : GuildEmojiRoleManager

A manager for roles this emoji is active for.

deprecatedreadonly
url : string

Returns a URL for the emoji.

Inherited from: BaseGuildEmoji

delete(
reason?: string
) : Promise<GuildEmoji>

Deletes the emoji.

edit(
options: GuildEmojiEditOptions
) : Promise<GuildEmoji>

Edits the emoji.

Examples:
// Edit an emoji
emoji.edit({ name: 'newemoji' })
  .then(emoji => console.log(`Edited emoji ${emoji}`))
  .catch(console.error);

equals(
other: GuildEmoji | unknown
) : boolean

Whether this emoji is the same as another one.

fetchAuthor() : Promise<User>

Fetches the author for this emoji

imageURL(
options?: BaseImageURLOptions
) : string

Returns a URL for the emoji.

Inherited from: BaseGuildEmoji

setName(
name: string
reason?: string
) : Promise<GuildEmoji>

Sets the name of the emoji.

toJSON() : unknown

Inherited from: Emoji

toString() : string

When concatenated with a string, this automatically returns the text required to form a graphical emoji on Discord instead of the Emoji object.

Examples:
// Send a custom emoji from a guild:
const emoji = guild.emojis.cache.first();
msg.channel.send(`Hello! ${emoji}`);
// Send the emoji used in a reaction to the channel the reaction is part of
reaction.message.channel.send(`The emoji used was: ${reaction.emoji}`);

Inherited from: Emoji

valueOf() : string

Inherited from: Base