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

Class RichCustomEmojiImpl

java.lang.Object

net.dv8tion.jda.internal.entities.emoji.RichCustomEmojiImpl

All Implemented Interfaces:

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

public class RichCustomEmojiImpl
extends Object
implements RichCustomEmoji, 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
RichCustomEmojiImpl(long id, GuildImpl guild)

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.
RichCustomEmojiImpl	copy()
AuditableRestAction<Void>	delete()	Deletes this emoji.
boolean	equals(Object obj)
String	getAsReactionCode()	The reaction code for this emoji.
GuildImpl	getGuild()	The Guild this emoji is attached to.
long	getIdLong()	The Snowflake id of this entity.
JDAImpl	getJDA()	The JDA instance of this emoji
CustomEmojiManager	getManager()	The Manager for this emoji, used to modify properties of the emoji like name and role restrictions.
String	getName()	The name of this emoji.
User	getOwner()	The user who created this emoji
List<Role>	getRoles()	Roles this emoji is active for.
Set<Role>	getRoleSet()
Emoji.Type	getType()	The Emoji.Type of this emoji.
int	hashCode()
boolean	isAnimated()	Whether this emoji is animated.
boolean	isAvailable()	Whether this emoji is available.
boolean	isManaged()	Whether this emoji is managed.
CacheRestAction<User>	retrieveOwner()	Retrieves the owner of this emoji.
RichCustomEmojiImpl	setAnimated(boolean animated)
RichCustomEmojiImpl	setAvailable(boolean available)
RichCustomEmojiImpl	setManaged(boolean val)
RichCustomEmojiImpl	setName(String name)
RichCustomEmojiImpl	setOwner(User user)
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, getAsMention, getFormatted, getImage, getImageUrl

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

getId, getTimeCreated

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

canInteract, canInteract, canInteract

Constructor Details

RichCustomEmojiImpl

public RichCustomEmojiImpl(long id,
 GuildImpl guild)

Method Details

getType

@Nonnull
public Emoji.Type getType()

Description copied from interface: Emoji

The Emoji.Type of this emoji.

Specified by:

getType in interface CustomEmoji

Specified by:

getType in interface Emoji

Returns:

The Emoji.Type

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>

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

getGuild

@Nonnull
public GuildImpl getGuild()

Description copied from interface: RichCustomEmoji

The Guild this emoji is attached to.

Specified by:

getGuild in interface RichCustomEmoji

Returns:

Guild of this emoji

getRoles

@Nonnull
public List<Role> getRoles()

Description copied from interface: RichCustomEmoji

Roles this emoji is active for.
Learn More

Specified by:

getRoles in interface RichCustomEmoji

Returns:

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

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

isManaged

public boolean isManaged()

Description copied from interface: RichCustomEmoji

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

Specified by:

isManaged in interface RichCustomEmoji

Returns:

True, if this emoji is managed

isAvailable

public boolean isAvailable()

Description copied from interface: RichCustomEmoji

Whether this emoji is available. When an emoji becomes unavailable, it cannot be used in messages. An emoji becomes unavailable when the BoostTier of the guild drops such that the maximum allowed emojis is lower than the total amount of emojis added to the guild.

If an emoji is added to the guild when the boost tier allows for more than 50 normal and 50 animated emojis (BoostTier is at least TIER_1) and the emoji is at least the 51st one added, then the emoji becomes unavailable when the BoostTier drops below a level that allows those emojis to be used.
emojis that where added as part of a lower BoostTier (i.e. the 51st emoji on BoostTier 2) will remain available, as long as the BoostTier stays above the required level.

Specified by:

isAvailable in interface RichCustomEmoji

Returns:

True, if this emoji is available

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.

getJDA

@Nonnull
public JDAImpl getJDA()

Description copied from interface: RichCustomEmoji

The JDA instance of this emoji

Specified by:

getJDA in interface RichCustomEmoji

Returns:

The JDA instance of this emoji

getOwner

public User getOwner()

Description copied from interface: RichCustomEmoji

The user who created this emoji

This is only available for manually retrieved emojis from Guild.retrieveEmojis() and Guild.retrieveEmojiById(long).
Requires Permission.MANAGE_GUILD_EXPRESSIONS.

Specified by:

getOwner in interface RichCustomEmoji

Returns:

The user who created this emoji, or null if not provided

See Also:

• RichCustomEmoji.retrieveOwner()

retrieveOwner

@Nonnull
public CacheRestAction<User> retrieveOwner()

Description copied from interface: RichCustomEmoji

Retrieves the owner of this emoji.
If RichCustomEmoji.getOwner() is present, this will directly return the owner in a completed RestAction without making a request. The user information might be outdated, you can use action.useCache(false) to force an update.

Specified by:

retrieveOwner in interface RichCustomEmoji

Returns:

RestAction - Type: User

See Also:

• RichCustomEmoji.getOwner()

getManager

@Nonnull
public CustomEmojiManager getManager()

Description copied from interface: RichCustomEmoji

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

Specified by:

getManager in interface RichCustomEmoji

Returns:

The CustomEmojiManager for this emoji

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

delete

@Nonnull
public AuditableRestAction<Void> delete()

Description copied from interface: RichCustomEmoji

Deletes this emoji.

Possible ErrorResponses include:

• UNKNOWN_EMOJI
  If this emoji was already removed
• UNKNOWN_GUILD
  If the Guild of this emoji was deleted
• MISSING_ACCESS
  If we were removed from the Guild

Specified by:

delete in interface RichCustomEmoji

Returns:

AuditableRestAction The RestAction to delete this emoji.

setName

public RichCustomEmojiImpl setName(String name)

setAnimated

public RichCustomEmojiImpl setAnimated(boolean animated)

setManaged

public RichCustomEmojiImpl setManaged(boolean val)

setAvailable

public RichCustomEmojiImpl setAvailable(boolean available)

setOwner

public RichCustomEmojiImpl setOwner(User user)

getRoleSet

public Set<Role> getRoleSet()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

copy

public RichCustomEmojiImpl copy()

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