GuildPreviewEmoji

classe · Source

Represents an instance of an emoji belonging to a public guild obtained through Discord's preview endpoint.

Extends: BaseGuildEmoji

Properties

guild

guild: GuildPreview

The public guild this emoji is part of Source

roles

roles: Array<Snowflake>

The roles this emoji is active for Source

requiresColons

nullable

requiresColons: boolean

Whether or not this emoji requires colons surrounding it Source

managed

nullable

managed: boolean

Whether this emoji is managed by an external service Source

available

nullable

available: boolean

Whether this emoji is available Source

animated

nullable

animated: boolean

Whether or not the emoji is animated Source

name

nullable

name: string

The emoji's name Source

id

nullable

id: Snowflake

The emoji's id Source

deleted

deprecated

deleted: boolean

Whether or not the structure has been deleted Source

identifier

readonly

identifier: string

The identifier of this emoji, used for message reactions Source

url

readonly · nullable

url: string

The URL to the emoji file if it's a custom emoji Source

createdTimestamp

readonly · nullable

createdTimestamp: number

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

createdAt

readonly · nullable

createdAt: Date

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

client

readonly

client: Client

The client that instantiated this Source

Methods

toString

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. Returns: string

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

Source