Interface CustomEmoji

All Superinterfaces:

Emoji, Formattable, IMentionable, ISnowflake, SerializableData

All Known Subinterfaces:

ApplicationEmoji, RichCustomEmoji

public interface CustomEmoji
extends Emoji, IMentionable

Represents a minimal custom emoji.

This contains the most minimal representation of a custom emoji, via id and name.

This does not represent unicode emojis like they are used in the official client! The format :smiley: is a client-side alias which is replaced by the unicode emoji, not a custom emoji.

See Also:

• Emoji.fromCustom(String, long, boolean)
• Emoji.fromCustom(CustomEmoji)
• Emoji.fromFormatted(String)
• Emoji.fromData(DataObject)

Nested Class Summary

Nested classes/interfaces inherited from interface Emoji

Emoji.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EMOJI_NAME_MAX_LENGTH
static final String	ICON_URL	Deprecated. Replaced by DiscordAssets.customEmoji(ImageFormat, String)

Method Summary

Modifier and Type	Method	Description
default void	formatTo(Formatter formatter, int flags, int width, int precision)
default String	getAsMention()	Usable representation of this emoji (used to display in the client just like mentions with a specific format) Emojis are used with the format <:getName():getId()>
default String	getFormatted()	Formatted string used in messages.
default ImageProxy	getImage()	Returns an ImageProxy for this emoji's image.
default ImageProxy	getImage(ImageFormat format)	Returns an ImageProxy for this emoji's image.
default String	getImageUrl()	A String representation of the URL which leads to image displayed within the official Discord™ client when this emoji is used
default String	getImageUrl(ImageFormat format)	A String representation of the URL which leads to image displayed within the official Discord™ client when this emoji is used
default Emoji.Type	getType()	The Emoji.Type of this emoji.
boolean	isAnimated()	Whether this emoji is animated.

Methods inherited from interface Emoji

getAsReactionCode, getName

Methods inherited from interface ISnowflake

getId, getIdLong, getTimeCreated

Methods inherited from interface SerializableData

toData

Field Details

EMOJI_NAME_MAX_LENGTH

static final int EMOJI_NAME_MAX_LENGTH

See Also:

• Constant Field Values

ICON_URL

@Deprecated
static final String ICON_URL

Deprecated.

Replaced by DiscordAssets.customEmoji(ImageFormat, String)

Template for getImageUrl()

See Also:

• Constant Field Values

Method Details

getType

@Nonnull
default Emoji.Type getType()

Description copied from interface: Emoji

The Emoji.Type of this emoji.

Specified by:

getType in interface Emoji

Returns:

The Emoji.Type

isAnimated

boolean isAnimated()

Whether this emoji is animated.

Returns:

True, if this emoji is animated

getImageUrl

@Nonnull
default String getImageUrl()

A String representation of the URL which leads to image displayed within the official Discord™ client when this emoji is used

Returns:

Discord CDN link to the emoji's image

getImageUrl

@Nonnull
default String getImageUrl(@Nonnull
 ImageFormat format)

A String representation of the URL which leads to image displayed within the official Discord™ client when this emoji is used

Parameters:

format - The format in which the image should be

Returns:

Discord CDN link to the emoji's image

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.customEmoji(ImageFormat, String)

getImage

@Nonnull
default ImageProxy getImage()

Returns an ImageProxy for this emoji's image.

Returns:

Never-null ImageProxy of this emoji's image

See Also:

• getImageUrl()

getImage

@Nonnull
default ImageProxy getImage(@Nonnull
 ImageFormat format)

Returns an ImageProxy for this emoji's image.

Parameters:

format - The format in which the image should be

Returns:

Never-null ImageProxy of this emoji's image

Throws:

IllegalArgumentException - If the format is null

See Also:

• getImageUrl(ImageFormat)
• DiscordAssets.customEmoji(ImageFormat, String)

getAsMention

@Nonnull
default String getAsMention()

Usable representation of this emoji (used to display in the client just like mentions with a specific format)
Emojis are used with the format <:getName():getId()>

Specified by:

getAsMention in interface IMentionable

Returns:

A usable String representation for this emoji

See Also:

• Message Formatting

getFormatted

@Nonnull
default String getFormatted()

Description copied from interface: Emoji

Formatted string used in messages.
For unicode emoji, this is simply Emoji.getName(). For custom emoji, this will be the mention markdown format <:name:id>.

Specified by:

getFormatted in interface Emoji

Returns:

The formatted message string

formatTo

default void formatTo(Formatter formatter,
 int flags,
 int width,
 int precision)

Specified by:

formatTo in interface Emoji

Specified by:

formatTo in interface Formattable

Specified by:

formatTo in interface IMentionable