Package com.mewna.catnip.entity.misc

Interface Emoji.UnicodeEmoji

All Superinterfaces:
Emoji, Entity, HasNullableName, Snowflake, Timestamped
All Known Implementing Classes:
UnicodeEmojiImpl
Enclosing interface:
Emoji
public static interface Emoji.UnicodeEmoji extends Emoji

  • Method Details

    • id

      @Nonnull default String id()
      Description copied from interface: Emoji
      ID of this emoji, or null if it has no ID.
      Always null for unicode emoji.
      Specified by:
      id in interface Emoji
      Specified by:
      id in interface Snowflake
      Returns:
      String representing the ID.

    • idAsLong

      default long idAsLong()
      Description copied from interface: Snowflake
      The ID of this snowflake, as a long.
      Specified by:
      idAsLong in interface Snowflake
      Returns:
      Long representing the ID.

    • roles

      @Nonnull @CheckReturnValue default List<String> roles()
      Description copied from interface: Emoji
      Roles that are allowed to use this emoji. If empty, all users can use it.
      Always empty for unicode emoji.
      Specified by:
      roles in interface Emoji
      Returns:
      List of role IDs allowed.

    • user

      @Nullable @CheckReturnValue default User user()
      Description copied from interface: Emoji
      User who uploaded this emoji.
      Always null for unicode emoji.
      Specified by:
      user in interface Emoji
      Returns:
      User who uploaded the emoji.

    • managed

      @CheckReturnValue default boolean managed()
      Description copied from interface: Emoji
      Whether this emoji is managed.
      Always false for unicode emoji.
      Specified by:
      managed in interface Emoji
      Returns:
      True if it's managed, false otherwise.

    • animated

      @CheckReturnValue default boolean animated()
      Description copied from interface: Emoji
      Whether this emoji is animated.
      Always false for unicode emoji.
      Specified by:
      animated in interface Emoji
      Returns:
      True if it's animated, false otherwise.

    • custom

      @CheckReturnValue default boolean custom()
      Description copied from interface: Emoji
      Whether this emoji is custom.
      Specified by:
      custom in interface Emoji
      Returns:
      True if this emoji is custom, false otherwise.

    • forMessage

      @Nonnull @CheckReturnValue default String forMessage()
      Description copied from interface: Emoji
      A string that may be sent in a message and will render this emoji, if the user has permission to.
      Specified by:
      forMessage in interface Emoji
      Returns:
      A string that yields this emoji when inside a message.

    • forReaction

      @Nonnull @CheckReturnValue default String forReaction()
      Description copied from interface: Emoji
      A string that may be added as a reaction to a message, if the user has permission to.
      Specified by:
      forReaction in interface Emoji
      Returns:
      A string that yields this emoji when added as a reaction.

    • is

      @CheckReturnValue default boolean is(@Nonnull String emoji)
      Description copied from interface: Emoji
      Checks whether or not this emoji is the provided emoji string.
      If this emoji is unicode, it's name is compared for equality with the provided string.
      If this emoji is custom, the following checks, in order, are applied:
      Specified by:
      is in interface Emoji
      Parameters:
      emoji - Emoji string to compare against.
      Returns:
      True, if this emoji is equal to the provided string.