Package net.essentialsx.api.v2.services.discord

Interface InteractionRole

All Known Implementing Classes:
InteractionRoleImpl
public interface InteractionRole
Represents a role of an interaction member.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canInteract()
    Whether this role can be given to other members by the current logged in bot.
    String
    getAsMention()
    Gets the mention of this role.
    int
    getColorRaw()
    Gets the raw RGB color value of this role.
    String
    getId()
    Gets the ID of this role.
    String
    getName()
    Gets the name of this role.
    boolean
    isDefaultColor()
    Whether this role's color is the default one (has no color).
    boolean
    isManaged()
    Whether this role is managed by an external integration.
    boolean
    isPublicRole()
    Whether this role is the default role given to all users (@everyone).

  • Method Details

    • getName

      String getName()
      Gets the name of this role.
      Returns:
      this role's name.

    • getAsMention

      String getAsMention()
      Gets the mention of this role.
      Returns:
      this role's mention.

    • isManaged

      boolean isManaged()
      Whether this role is managed by an external integration.
      Returns:
      true if the role is managed.

    • isPublicRole

      boolean isPublicRole()
      Whether this role is the default role given to all users (@everyone).
      Returns:
      true if this is the default role.

    • getColorRaw

      int getColorRaw()
      Gets the raw RGB color value of this role.
      Returns:
      this role's color value.

    • isDefaultColor

      boolean isDefaultColor()
      Whether this role's color is the default one (has no color).
      Returns:
      true if the role has no color.

    • canInteract

      boolean canInteract()
      Whether this role can be given to other members by the current logged in bot.
      Returns:
      true if this role can be interacted with by the current bot user.

    • getId

      String getId()
      Gets the ID of this role.
      Returns:
      this role's ID.