discord.js | GuildEmoji

Search...

GuildEmoji

export class GuildEmoji extends BaseGuildEmoji

export class GuildEmoji extends BaseGuildEmoji

Represents a custom emoji.

Extends

BaseGuildEmoji

animated?:boolean

Whether or not the emoji is animated

author:User | null

The user who created this emoji

available?:boolean

Whether this emoji is available

Readonly

client:Client

The client that instantiated this

Readonly

createdAt?:Date

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

Readonly

createdTimestamp?:number

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

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

Readonly

identifier:string

The identifier of this emoji, used for message reactions

managed?:boolean

Whether this emoji is managed by an external service

name?:string

The emoji's name

requiresColons?:boolean

Whether or not this emoji requires colons surrounding it

Readonly

roles:GuildEmojiRoleManager

A manager for roles this emoji is active for.

Readonly

url:string

Returns a URL for the emoji.

delete(reason?):Promise<GuildEmoji>

Deletes the emoji.

Name	Type	Optional	Description
reason	string	Yes	Reason for deleting the emoji

edit(options):Promise<GuildEmoji>

Edits the emoji.

Example

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

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

Name	Type	Optional	Description
options	GuildEmojiEditOptions	No	The options to provide

equals(other):boolean

Whether this emoji is the same as another one.

Name	Type	Optional	Description
other	GuildEmoji \| unknown	No	The emoji to compare it to

fetchAuthor():Promise<User>

Fetches the author for this emoji

imageURL(options?):string

Returns a URL for the emoji.

Name	Type	Optional	Description
options	BaseImageURLOptions	Yes	Options for the image URL

Inherited from BaseGuildEmoji

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

Sets the name of the emoji.

Name	Type	Optional	Description
name	string	No	The new name for the emoji
reason	string	Yes	Reason for changing the emoji's name

toJSON():unknown

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.

Example

// Send a custom emoji from a guild:
const emoji = guild.emojis.cache.first();
msg.channel.send(`Hello! ${emoji}`);

// Send a custom emoji from a guild:
const emoji = guild.emojis.cache.first();
msg.channel.send(`Hello! ${emoji}`);

Example

// 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}`);

// 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