Package net.dv8tion.jda.core.entities

Interface Emote

All Superinterfaces:

java.util.Formattable, IFakeable, IMentionable, ISnowflake

All Known Subinterfaces:

ListedEmote

public interface Emote
extends ISnowflake, IMentionable, IFakeable

Represents a Custom Emote. (Custom Emoji in official Discord API terminology)

You can retrieve the creator of an emote by using Guild.retrieveEmote(Emote) followed by using ListedEmote.getUser().

This does not represent unicode emojis like they are used in the official client! (:smiley: is not a custom emoji)

Fake Emote

When an emote is declared as fake it cannot be updated by JDA. That means it will not be accessible through cache such as Guild.getEmoteCache() and similar.
Fake emotes may or may not have an attached Guild and thus might not be manageable though getManager() or delete(). They also might lack attached roles for getRoles().

Since:

2.2

See Also:

ListedEmote

Method Summary

Modifier and Type	Method	Description
default boolean	canInteract(Member issuer)	Whether the specified Member can interact with this Emote
default boolean	canInteract(User issuer, MessageChannel channel)	Whether the specified User can interact with this Emote within the provided MessageChannel Same logic as canInteract(issuer, channel, true)!
default boolean	canInteract(User issuer, MessageChannel channel, boolean botOverride)	Whether the specified User can interact with this Emote within the provided MessageChannel Special override to exclude elevated bot permissions in case of (for instance) reacting to messages.
boolean	canProvideRoles()	Whether this Emote has an attached roles list.
AuditableRestAction<java.lang.Void>	delete()	Deletes this Emote.
default java.lang.String	getAsMention()	Usable representation of this Emote (used to display in the client just like mentions with a specific format) Emotes are used with the format <:getName():getId()>
Guild	getGuild()	The Guild this emote is attached to.
default java.lang.String	getImageUrl()	A String representation of the URL which leads to image displayed within the official Discord™ client when this Emote is used
JDA	getJDA()	The JDA instance of this Emote
EmoteManager	getManager()	The Manager for this emote, used to modify properties of the emote like name and role restrictions.
java.lang.String	getName()	The name of this emote
java.util.List<Role>	getRoles()	Roles this emote is active for Learn More
default boolean	hasRoles()	Deprecated. This will be replaced by canProvideRoles()
boolean	isAnimated()	Whether or not this Emote is animated.
boolean	isManaged()	Whether this emote is managed.

Methods inherited from interface net.dv8tion.jda.core.entities.IFakeable

isFake

Methods inherited from interface net.dv8tion.jda.core.entities.IMentionable

formatTo

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

getCreationTime, getId, getIdLong

Method Detail

getGuild

Guild getGuild()

The Guild this emote is attached to.

This is null if the emote is fake (retrieved from a Message)

Returns:

Guild of this emote or null if it is a fake entity

getRoles

java.util.List<Role> getRoles()

Roles this emote is active for
Learn More

Returns:

An immutable list of the roles this emote is active for (all roles if empty)

Throws:

java.lang.IllegalStateException - If this Emote does not have attached roles according to canProvideRoles()

See Also:

canProvideRoles()

hasRoles

@Deprecated
@DeprecatedSince("3.8.0")
@ReplaceWith("canProvideRoles()")
default boolean hasRoles()

Deprecated. This will be replaced by canProvideRoles()

Whether this Emote has attached roles. This might not be the case when the emote is retrieved through special cases like audit-logs.

If this is not true then getRoles() will throw IllegalStateException.

Returns:

True, if this emote has roles attached

canProvideRoles

boolean canProvideRoles()

Whether this Emote has an attached roles list. This might not be the case when the emote is retrieved through special cases like audit-logs.

If this is not true then getRoles() will throw IllegalStateException.

Returns:

True, if this emote has an attached roles list

getName

java.lang.String getName()

The name of this emote

Returns:

String representation of this emote's name

isManaged

boolean isManaged()

Whether this emote is managed. A managed Emote is controlled by Discord, not the Guild administrator, typical via a service like BBTV in conjunction with Twitch.
Learn More

Returns:

True, if this emote is managed

getJDA

JDA getJDA()

The JDA instance of this Emote

Returns:

The JDA instance of this Emote

delete

@CheckReturnValue
AuditableRestAction<java.lang.Void> delete()

Deletes this Emote.

Possible ErrorResponses include:

• UNKNOWN_EMOTE
  If this Emote was already removed
• UNKNOWN_GUILD
  If the Guild of this Emote was deleted
• MISSING_ACCESS
  If we were removed from the Guild

Returns:

AuditableRestAction The RestAction to delete this Emote.

Throws:

java.lang.IllegalStateException - if this Emote is fake (IFakeable.isFake())

java.lang.UnsupportedOperationException - If this emote is managed by discord (isManaged())

InsufficientPermissionException - if the Permission MANAGE_EMOTES is not given

getManager

EmoteManager getManager()

The Manager for this emote, used to modify properties of the emote like name and role restrictions.
You modify multiple fields in one request by chaining setters before calling RestAction.queue().

Returns:

The EmoteManager for this Emote

Throws:

java.lang.IllegalStateException - if this emote is fake

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_EMOTES

isAnimated

boolean isAnimated()

Whether or not this Emote is animated.

Animated Emotes are available to Discord Nitro users as well as Bot accounts.

Returns:

Whether the Emote is animated or not.

getImageUrl

default java.lang.String getImageUrl()

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

Returns:

Discord CDN link to the Emote's image

getAsMention

default java.lang.String getAsMention()

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

Specified by:

getAsMention in interface IMentionable

Returns:

A usable String representation for this Emote

See Also:

Message Formatting

canInteract

default boolean canInteract(Member issuer)

Whether the specified Member can interact with this Emote

Parameters:

issuer - The User to test

Returns:

True, if the provided Member can use this Emote

See Also:

PermissionUtil.canInteract(Member, Emote), PermissionUtil.canInteract(User, Emote, MessageChannel)

canInteract

default boolean canInteract(User issuer,
                            MessageChannel channel)

Whether the specified User can interact with this Emote within the provided MessageChannel
Same logic as canInteract(issuer, channel, true)!

Parameters:

issuer - The User to test

channel - The MessageChannel to test

Returns:

True, if the provided Member can use this Emote

See Also:

PermissionUtil.canInteract(Member, Emote), PermissionUtil.canInteract(User, Emote, MessageChannel)

canInteract

default boolean canInteract(User issuer,
                            MessageChannel channel,
                            boolean botOverride)

Whether the specified User can interact with this Emote within the provided MessageChannel
Special override to exclude elevated bot permissions in case of (for instance) reacting to messages.

Parameters:

issuer - The User to test

channel - The MessageChannel to test

botOverride - Whether bots can use non-managed emotes in other guilds

Returns:

True, if the provided Member can use this Emote

See Also:

PermissionUtil.canInteract(Member, Emote), PermissionUtil.canInteract(User, Emote, MessageChannel, boolean)