discord.js | GuildEmojiManager

Search...

GuildEmojiManager

export class GuildEmojiManager extends BaseGuildEmojiManager

export class GuildEmojiManager extends BaseGuildEmojiManager

Manages API methods for GuildEmojis and stores their cache.

Extends

BaseGuildEmojiManager

cache:Collection<Snowflake, GuildEmoji>

The cache of GuildEmojis

Readonly

client:Client

The client that instantiated this Manager

guild:Guild

The guild this manager belongs to

Readonly

holds:Constructable<Holds>

The data structure belonging to this manager.

Inherited from DataManager

create(options):Promise<GuildEmoji>

Creates a new custom emoji in the guild.

Returns

The created emoji

Example

// Create a new emoji from a URL
guild.emojis.create({ attachment: 'https://i.imgur.com/w3duR07.png', name: 'rip' })
  .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`))
  .catch(console.error);

// Create a new emoji from a URL
guild.emojis.create({ attachment: 'https://i.imgur.com/w3duR07.png', name: 'rip' })
  .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`))
  .catch(console.error);

Example

// Create a new emoji from a file on your computer
guild.emojis.create({ attachment: './memes/banana.png', name: 'banana' })
  .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`))
  .catch(console.error);

// Create a new emoji from a file on your computer
guild.emojis.create({ attachment: './memes/banana.png', name: 'banana' })
  .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`))
  .catch(console.error);

Name	Type	Optional	Description
options	GuildEmojiCreateOptions	No	Options for creating the emoji

delete(emoji, reason?):Promise<void>

Deletes an emoji.

Name	Type	Optional	Description
emoji	EmojiResolvable	No	The Emoji resolvable to delete
reason	string	Yes	Reason for deleting the emoji

edit(emoji, options):Promise<GuildEmoji>

Edits an emoji.

Name	Type	Optional	Description
emoji	EmojiResolvable	No	The Emoji resolvable to edit
options	GuildEmojiEditOptions	No	The options to provide

fetch(id, options?):Promise<GuildEmoji>

Obtains one or more emojis from Discord, or the emoji cache if they're already available.

Example

// Fetch all emojis from the guild
message.guild.emojis.fetch()
  .then(emojis => console.log(`There are ${emojis.size} emojis.`))
  .catch(console.error);

// Fetch all emojis from the guild
message.guild.emojis.fetch()
  .then(emojis => console.log(`There are ${emojis.size} emojis.`))
  .catch(console.error);

Example

// Fetch a single emoji
message.guild.emojis.fetch('222078108977594368')
  .then(emoji => console.log(`The emoji name is: ${emoji.name}`))
  .catch(console.error);

// Fetch a single emoji
message.guild.emojis.fetch('222078108977594368')
  .then(emoji => console.log(`The emoji name is: ${emoji.name}`))
  .catch(console.error);

Name	Type	Optional	Description
id	Snowflake	No	The emoji's id
options	BaseFetchOptions	Yes	Additional options for this fetch

fetchAuthor(emoji):Promise<User>

Fetches the author for this emoji

Name	Type	Optional	Description
emoji	EmojiResolvable	No	The emoji to fetch the author of

resolve(emoji):GuildEmoji

Resolves an EmojiResolvable to an Emoji object.

Name	Type	Optional	Description
emoji	EmojiResolvable	No	The Emoji resolvable to identify

Inherited from BaseGuildEmojiManager

resolveId(emoji):Snowflake

Resolves an EmojiResolvable to an Emoji id string.

Name	Type	Optional	Description
emoji	EmojiResolvable	No	The Emoji resolvable to identify

Inherited from BaseGuildEmojiManager

resolveIdentifier(emoji):string | null

Resolves an EmojiResolvable to an emoji identifier.

Returns

Name	Type	Optional	Description
emoji	EmojiIdentifierResolvable	No	The emoji resolvable to resolve

Inherited from BaseGuildEmojiManager

valueOf():Collection<Key, Holds>