Package discord4j.core.object.entity

Class ForumTag

java.lang.Object
discord4j.core.object.entity.ForumTag
All Implemented Interfaces:
DiscordObject, Entity
public class ForumTag extends Object implements Entity

  • Field Details

  • Constructor Details

    • ForumTag

      public ForumTag(GatewayDiscordClient gateway, discord4j.discordjson.json.ForumTagData data)

  • Method Details

    • getClient

      public GatewayDiscordClient getClient()
      Description copied from interface: DiscordObject
      Returns the GatewayDiscordClient that created this object. Methods in it are exclusively based on the entity cache or Store in use. Refer to calling getClient().rest() to access a DiscordClient that is capable of requesting entities directly from the REST API.
      Specified by:
      getClient in interface DiscordObject
      Returns:
      The GatewayDiscordClient associated to this object.

    • getId

      public Snowflake getId()
      Description copied from interface: Entity
      Gets the Snowflake that uniquely identifies this entity.
      Specified by:
      getId in interface Entity
      Returns:
      The Snowflake that uniquely identifies this entity.

    • getName

      public String getName()
      Gets the name for this tag
      Returns:
      The tag name

    • isModerated

      public boolean isModerated()
      Gets whether this tag is moderated, meaning only members with the MANAGE_THREADS permission can use it
      Returns:
      true if this tag is moderated

    • getEmojiId

      public Optional<Snowflake> getEmojiId()
      Gets the emoji id if this tag is represented as a custom guild emoji At least this field or getEmojiName() is present and filled.
      Returns:
      An Optional which may contain a custom guild emoji id.

    • getEmojiName

      public Optional<String> getEmojiName()
      Gets the unicode emoji if this tag is represented as a unicode emoji At least this field or getEmojiId() is present and filled.
      Returns:
      An Optional which may contain a custom guild emoji id.

    • getData

      public discord4j.discordjson.json.ForumTagData getData()
      Gets the associated ForumTagData wrapped by this object
      Returns:
      the wrapped ForumTagData object