Preview environment

class GuildEmojiManager

export class GuildEmojiManager extends BaseGuildEmojiManager

Manages API methods for GuildEmojis and stores their cache.

readonly
cache : Collection<Key, Holds>

The cache of items for this manager.

Inherited from: DataManager

readonly
client : Client

The client that instantiated this Manager

Inherited from: BaseManager

guild : Guild

The guild this manager belongs to

readonly
holds : Constructable<Holds>

The data structure belonging to this manager.

Inherited from: DataManager

create(
options: GuildEmojiCreateOptions
) : Promise<GuildEmoji>

Creates a new custom emoji in the guild.

Examples:
// 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 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);

Returns: The created emoji

delete(
emoji: EmojiResolvable
reason?: string
) : Promise<void>

Deletes an emoji.

edit(
emoji: EmojiResolvable
options: GuildEmojiEditOptions
) : Promise<GuildEmoji>

Edits an emoji.

fetch(
id: Snowflake
options?: BaseFetchOptions
) : Promise<GuildEmoji>

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

Examples:
// Fetch all emojis from the guild
message.guild.emojis.fetch()
  .then(emojis => console.log(`There are ${emojis.size} emojis.`))
  .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);

fetchAuthor(
emoji: EmojiResolvable
) : Promise<User>

Fetches the author for this emoji

resolve(
emoji: EmojiResolvable
) : GuildEmoji | null

Resolves an EmojiResolvable to an Emoji object.

Inherited from: BaseGuildEmojiManager

resolveId(
emoji: EmojiResolvable
) : Snowflake | null

Resolves an EmojiResolvable to an Emoji id string.

Inherited from: BaseGuildEmojiManager

resolveIdentifier(
emoji: EmojiIdentifierResolvable
) : string | null

Resolves an EmojiResolvable to an emoji identifier.

Inherited from: BaseGuildEmojiManager

valueOf() : Collection<Key, Holds>

Inherited from: DataManager