Package net.dv8tion.jda.api.entities

Class MessageReaction.ReactionEmote

java.lang.Object
net.dv8tion.jda.api.entities.MessageReaction.ReactionEmote
All Implemented Interfaces:
ISnowflake
Enclosing class:
MessageReaction
public static class MessageReaction.ReactionEmote extends Object implements ISnowflake
Represents an Emoji/Emote of a MessageReaction
This is used to wrap both emojis and emotes

  • Method Details

    • fromUnicode

      @Nonnull public static MessageReaction.ReactionEmote fromUnicode(@Nonnull String name, @Nonnull JDA api)

    • fromCustom

      @Nonnull public static MessageReaction.ReactionEmote fromCustom(@Nonnull Emote emote)

    • isEmote

      public boolean isEmote()
      Whether this is an Emote wrapper.
      This means getEmoji() will throw IllegalStateException.
      Returns:
      True, if getEmote() can be used
      See Also:

    • isEmoji

      public boolean isEmoji()
      Whether this represents a unicode emoji.
      This means getEmote(), ISnowflake.getId(), and getIdLong() will not be available.
      Returns:
      True, if this represents a unicode emoji
      See Also:

    • getName

      @Nonnull public String getName()
      The name for this emote/emoji
      For unicode emojis this will be the unicode of said emoji rather than an alias like :smiley:.

      For better use in consoles that do not support unicode emoji use getAsCodepoints() for a more readable representation of the emoji.

      Custom emotes may return an empty string for this if the emote was deleted.

      Returns:
      The name for this emote/emoji

    • getAsCodepoints

      @Nonnull public String getAsCodepoints()
      Converts the unicode name into codepoint notation like U+1F602.
      Returns:
      String containing the codepoint representation of the reaction emoji
      Throws:
      IllegalStateException - If this is not an emoji reaction, see isEmoji()

    • 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.

    • getAsReactionCode

      @Nonnull public String getAsReactionCode()
      The code for this Reaction.
      For unicode emojis this will be the unicode of said emoji rather than an alias like :smiley:.
      For custom emotes this will be the name and id of said emote in the format <name>:<id>.
      Returns:
      The unicode if it is an emoji, or the name and id in the format <name>:<id>

    • getEmoji

      @Nonnull public String getEmoji()
      The unicode representing the emoji used for reacting.
      Returns:
      The unicode for the emoji
      Throws:
      IllegalStateException - If this is not an emoji reaction, see isEmoji()

    • getEmote

      @Nonnull public Emote getEmote()
      The instance of Emote for the Reaction instance.
      Returns:
      The Emote for the Reaction instance
      Throws:
      IllegalStateException - If this is not a custom emote reaction, see isEmote()

    • getJDA

      @Nonnull public JDA getJDA()
      The current JDA instance for the Reaction
      Returns:
      The JDA instance of the Reaction

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object