discord.js | ApplicationEmoji

Search...

ApplicationEmoji

export class ApplicationEmoji extends Emoji

export class ApplicationEmoji extends Emoji

Represents a custom emoji.

Extends

Emoji

animated:boolean | null

Whether or not the emoji is animated

Inherited from Emoji

application:ClientApplication

The application this emoji originates from

author:User | null

The user who created this emoji

Readonly

client:Client<true>

The client that instantiated this

Inherited from Base

Readonly

createdAt:Date | null

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

Inherited from Emoji

Readonly

createdTimestamp:number | null

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

Inherited from Emoji

id:Snowflake

The emoji's id

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

name:string | null

The emoji's name

Inherited from Emoji

requiresColons:boolean | null

Whether or not this emoji requires colons surrounding it

Readonly

url:string | null

Inherited from Emoji

delete():Promise<ApplicationEmoji>

Deletes the emoji.

edit(options):Promise<ApplicationEmoji>

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	ApplicationEmojiEditOptions	No	The options to provide

equals(other):boolean

Whether this emoji is the same as another one.

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

fetchAuthor():Promise<User>

Fetches the author for this emoji

imageURL(options?):string | null

Returns a URL for the emoji or null if this is not a custom emoji.

Returns

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

Inherited from Emoji

setName(name):Promise<ApplicationEmoji>

Sets the name of the emoji.

Name	Type	Optional	Description
name	string	No	The new name for the emoji

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