Class TemplateRole

All Implemented Interfaces:

public class TemplateRole extends Object implements ISnowflake
POJO for the roles information provided by a template.
See Also:
  • Constructor Details

    • TemplateRole

      public TemplateRole(long id, String name, int color, boolean hoisted, boolean mentionable, long rawPermissions)
  • Method Details

    • getIdLong

      public long getIdLong()
      The ids of roles are their position as stored by Discord so this will not look like a typical snowflake.
      Specified by:
      getIdLong in interface ISnowflake
      The id of the role as stored by Discord
    • getTimeCreated

      public OffsetDateTime getTimeCreated()
      As the ids of roles are their position, the date of creation cannot be calculated.
      Specified by:
      getTimeCreated in interface ISnowflake
      OffsetDateTime - Time this entity was created at.
      UnsupportedOperationException - The date of creation cannot be calculated.
      See Also:
    • getName

      @Nonnull public String getName()
      The Name of this Role.
      Never-null String containing the name of this Role.
    • getColor

      @Nullable public Color getColor()
      The color this Role is displayed in.
      Color value of Role-color
      See Also:
    • getColorRaw

      public int getColorRaw()
      The raw color RGB value used for this role
      Defaults to Role.DEFAULT_COLOR_RAW if this role has no set color
      The raw RGB color value or default
    • isHoisted

      public boolean isHoisted()
      Whether this Role is hoisted
      Members in a hoisted role are displayed in their own grouping on the user-list
      True, if this Role is hoisted.
    • isMentionable

      public boolean isMentionable()
      Whether or not this Role is mentionable
      True, if Role is mentionable.
    • getPermissions

      @Nonnull public EnumSet<Permission> getPermissions()
      The Guild-Wide Permissions this PermissionHolder holds.
      Changes to the returned set do not affect this entity directly.
      An EnumSet of Permissions granted to this PermissionHolder.
    • getPermissionsRaw

      public long getPermissionsRaw()
      The long representation of the literal permissions that this Role has.
      Never-negative long containing offset permissions of this role.