Package net.dv8tion.jda.internal.entities.emoji

Class CustomEmojiImpl

java.lang.Object

net.dv8tion.jda.internal.entities.emoji.CustomEmojiImpl

All Implemented Interfaces:

Formattable, CustomEmoji, Emoji, EmojiUnion, IMentionable, ISnowflake, SerializableData

public class CustomEmojiImpl
extends Object
implements CustomEmoji, EmojiUnion

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.emoji.Emoji

Emoji.Type

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.emoji.CustomEmoji

EMOJI_NAME_MAX_LENGTH, ICON_URL

Constructor Summary

Constructors

Constructor	Description
CustomEmojiImpl(String name, long id, boolean animated)

Method Summary

Modifier and Type	Method	Description
ApplicationEmoji	asApplication()	Returns the underlying ApplicationEmoji if applicable.
CustomEmoji	asCustom()	Returns the underlying CustomEmoji if applicable.
RichCustomEmoji	asRich()	Returns the underlying RichCustomEmoji if applicable.
UnicodeEmoji	asUnicode()	Returns the underlying UnicodeEmoji if applicable.
boolean	equals(Object obj)
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()>
String	getAsReactionCode()	The reaction code for this emoji.
String	getFormatted()	Formatted string used in messages.
long	getIdLong()	The Snowflake id of this entity.
String	getName()	The name of this emoji.
int	hashCode()
boolean	isAnimated()	Whether this emoji is animated.
DataObject	toData()	Serialized DataObject for this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.emoji.CustomEmoji

formatTo, getImage, getImageUrl, getType

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Constructor Details

CustomEmojiImpl

public CustomEmojiImpl(String name,
 long id,
 boolean animated)

Method Details

getAsReactionCode

@Nonnull
public String getAsReactionCode()

Description copied from interface: Emoji

The reaction code for this emoji.
For unicode emojis this will be the unicode of said emoji rather than an alias like :smiley:.
For custom emojis this will be the name and id of said emoji in the format <name>:<id>.

Specified by:

getAsReactionCode in interface Emoji

Returns:

The unicode if it is an emoji, or the name and id in the format <name>:<id>

getName

@Nonnull
public String getName()

Description copied from interface: Emoji

The name of this emoji.
This will be the unicode characters if this emoji is not of Emoji.getType() CUSTOM.

Specified by:

getName in interface Emoji

Returns:

The unicode or custom name

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

isAnimated

public boolean isAnimated()

Description copied from interface: CustomEmoji

Whether this emoji is animated.

Specified by:

isAnimated in interface CustomEmoji

Returns:

True, if this emoji is animated

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

getAsMention

@Nonnull
public String getAsMention()

Description copied from interface: CustomEmoji

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 CustomEmoji

Specified by:

getAsMention in interface IMentionable

Returns:

A usable String representation for this emoji

See Also:

• Message Formatting

getFormatted

@Nonnull
public 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 CustomEmoji

Specified by:

getFormatted in interface Emoji

Returns:

The formatted message string

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

asUnicode

@Nonnull
public UnicodeEmoji asUnicode()

Description copied from interface: EmojiUnion

Returns the underlying UnicodeEmoji if applicable.

Specified by:

asUnicode in interface EmojiUnion

Returns:

The UnicodeEmoji

asCustom

@Nonnull
public CustomEmoji asCustom()

Description copied from interface: EmojiUnion

Returns the underlying CustomEmoji if applicable.

Specified by:

asCustom in interface EmojiUnion

Returns:

The CustomEmoji

asRich

@Nonnull
public RichCustomEmoji asRich()

Description copied from interface: EmojiUnion

Returns the underlying RichCustomEmoji if applicable.

Specified by:

asRich in interface EmojiUnion

Returns:

The RichCustomEmoji

asApplication

@Nonnull
public ApplicationEmoji asApplication()

Description copied from interface: EmojiUnion

Returns the underlying ApplicationEmoji if applicable.

Specified by:

asApplication in interface EmojiUnion

Returns:

The ApplicationEmoji