Package org.javacord.api.entity.emoji

Interface Emoji

All Superinterfaces:

Mentionable, Specializable<Emoji>

All Known Subinterfaces:

CustomEmoji, KnownCustomEmoji

public interface Emoji
extends Mentionable, Specializable<Emoji>

This class represents an emoji which can be a custom emoji (known or unknown) or a unicode emoji.

Method Summary

Modifier and Type	Method	Description
default java.util.Optional<CustomEmoji>	asCustomEmoji()	Gets the emoji as a custom emoji.
default java.util.Optional<KnownCustomEmoji>	asKnownCustomEmoji()	Gets the emoji as a known custom emoji.
java.util.Optional<java.lang.String>	asUnicodeEmoji()	Gets the emoji as a unicode emoji.
default boolean	equalsEmoji(java.lang.String otherEmoji)	Checks if the emoji is equal to the given unicode emoji.
default boolean	equalsEmoji(Emoji otherEmoji)	Checks if the emoji is equal to the given emoji.
boolean	isAnimated()	Checks if the emoji is animated.
default boolean	isCustomEmoji()	Checks if the emoji is a custom emoji.
default boolean	isKnownCustomEmoji()	Checks if the emoji is a known custom emoji.
default boolean	isUnicodeEmoji()	Checks if the emoji is a unicode.

Methods inherited from interface org.javacord.api.entity.Mentionable

getMentionTag

Methods inherited from interface org.javacord.api.util.Specializable

as

Method Detail

asUnicodeEmoji

java.util.Optional<java.lang.String> asUnicodeEmoji()

Gets the emoji as a unicode emoji.

Returns:

The emoji as a unicode emoji.

asCustomEmoji

default java.util.Optional<CustomEmoji> asCustomEmoji()

Gets the emoji as a custom emoji.

Returns:

The emoji as a custom emoji.

asKnownCustomEmoji

default java.util.Optional<KnownCustomEmoji> asKnownCustomEmoji()

Gets the emoji as a known custom emoji.

Returns:

The emoji as a known custom emoji.

equalsEmoji

default boolean equalsEmoji(Emoji otherEmoji)

Checks if the emoji is equal to the given emoji. This can be used to save some ugly optional checks.

Parameters:

otherEmoji - The emoji to compare with.

Returns:

Whether the emoji is equal to the given emoji.

equalsEmoji

default boolean equalsEmoji(java.lang.String otherEmoji)

Checks if the emoji is equal to the given unicode emoji. This can be used to save some ugly optional checks.

Parameters:

otherEmoji - The unicode emoji to compare with.

Returns:

Whether the emoji is equal to the given unicode emoji.

isAnimated

boolean isAnimated()

Checks if the emoji is animated. Always returns false for unicode emojis.

Returns:

Whether the emoji is animated or not.

isUnicodeEmoji

default boolean isUnicodeEmoji()

Checks if the emoji is a unicode.

Returns:

Whether the emoji is a unicode emoji or not.

isCustomEmoji

default boolean isCustomEmoji()

Checks if the emoji is a custom emoji.

Returns:

Whether the emoji is a custom emoji or not.

isKnownCustomEmoji

default boolean isKnownCustomEmoji()

Checks if the emoji is a known custom emoji.

Returns:

Whether the emoji is a known custom emoji or not.