Package net.dv8tion.jda.api.entities

Class Activity.Emoji

java.lang.Object

net.dv8tion.jda.api.entities.Activity.Emoji

All Implemented Interfaces:

Formattable, IMentionable, ISnowflake

Enclosing interface:

Activity

public static class Activity.Emoji
extends Object
implements ISnowflake, IMentionable

Emoji for a custom status.
This can be a unicode emoji or a custom emoji (Emote).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAsCodepoints()	The codepoint notation ("U+XXXX") for the unicode of this emoji.
String	getAsMention()	Retrieve a Mention for this Entity.
long	getIdLong()	The id for this custom emoji.
String	getName()	The name of this emoji.
int	hashCode()
boolean	isAnimated()	Whether this emoji is animated.
boolean	isEmoji()	Whether this is a unicode emoji.
boolean	isEmote()	Whether this is a custom emoji (Emote)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

formatTo

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

getId, getTimeCreated

Constructor Detail

Emoji

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

Emoji

public Emoji(String name)

Method Detail

getName

@Nonnull
public String getName()

The name of this emoji. This will be the unicode characters for a unicode emoji and the name of the custom emote otherwise.

Returns:

The emoji name

See Also:

getAsCodepoints()

getAsCodepoints

@Nonnull
public String getAsCodepoints()

The codepoint notation ("U+XXXX") for the unicode of this emoji. Not available for custom emotes.

Returns:

The codepoint notation

Throws:

IllegalStateException - If isEmoji() is false

See Also:

getName()

getIdLong

public long getIdLong()

The id for this custom emoji.

Specified by:

getIdLong in interface ISnowflake

Returns:

The emoji id

Throws:

IllegalStateException - If isEmote() is false

isAnimated

public boolean isAnimated()

Whether this emoji is animated. This is always false for unicode emoji.

Returns:

True, if this emoji is animated

isEmoji

public boolean isEmoji()

Whether this is a unicode emoji.

Returns:

True, if this is a unicode emoji

isEmote

public boolean isEmote()

Whether this is a custom emoji (Emote)

Returns:

True, if this is a custom emoji

getAsMention

@Nonnull
public String getAsMention()

Description copied from interface: IMentionable

Retrieve a Mention for this Entity. For the public Role (@everyone), this will return the literal string "@everyone".

Specified by:

getAsMention in interface IMentionable

Returns:

A resolvable mention.

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