Class TemplateRole
- java.lang.Object
-
- net.dv8tion.jda.api.entities.templates.TemplateRole
-
- All Implemented Interfaces:
ISnowflake
public class TemplateRole extends java.lang.Object implements ISnowflake
POJO for the roles information provided by a template.- See Also:
TemplateGuild.getRoles()
-
-
Constructor Summary
Constructors Constructor Description TemplateRole(long id, java.lang.String name, int color, boolean hoisted, boolean mentionable, long rawPermissions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.awt.ColorgetColor()The color thisRoleis displayed in.intgetColorRaw()The raw color RGB value used for this role
Defaults toRole.DEFAULT_COLOR_RAWif this role has no set colorlonggetIdLong()The ids of roles are their position as stored by Discord so this will not look like a typical snowflake.java.lang.StringgetName()The Name of thisRole.java.util.EnumSet<Permission>getPermissions()The Guild-Wide Permissions this PermissionHolder holds.longgetPermissionsRaw()Thelongrepresentation of the literal permissions that thisRolehas.java.time.OffsetDateTimegetTimeCreated()As the ids of roles are their position, the date of creation cannot be calculated.booleanisHoisted()Whether thisRoleis hoisted
Members in a hoisted role are displayed in their own grouping on the user-listbooleanisMentionable()Whether or not this Role is mentionable-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId
-
-
-
-
Method Detail
-
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:
getIdLongin interfaceISnowflake- Returns:
- The id of the role as stored by Discord
-
getTimeCreated
public java.time.OffsetDateTime getTimeCreated()
As the ids of roles are their position, the date of creation cannot be calculated.- Specified by:
getTimeCreatedin interfaceISnowflake- Returns:
- OffsetDateTime - Time this entity was created at.
- Throws:
java.lang.UnsupportedOperationException- The date of creation cannot be calculated.- See Also:
TimeUtil.getTimeCreated(long)
-
getName
@Nonnull public java.lang.String getName()
The Name of thisRole.- Returns:
- Never-null String containing the name of this
Role.
-
getColor
@Nullable public java.awt.Color getColor()
The color thisRoleis displayed in.- Returns:
- Color value of Role-color
- See Also:
getColorRaw()
-
getColorRaw
public int getColorRaw()
The raw color RGB value used for this role
Defaults toRole.DEFAULT_COLOR_RAWif this role has no set color- Returns:
- The raw RGB color value or default
-
isHoisted
public boolean isHoisted()
Whether thisRoleis hoisted
Members in a hoisted role are displayed in their own grouping on the user-list- Returns:
- True, if this
Roleis hoisted.
-
isMentionable
public boolean isMentionable()
Whether or not this Role is mentionable- Returns:
- True, if Role is mentionable.
-
getPermissions
@Nonnull public java.util.EnumSet<Permission> getPermissions()
The Guild-Wide Permissions this PermissionHolder holds.
Changes to the returned set do not affect this entity directly.- Returns:
- An EnumSet of Permissions granted to this PermissionHolder.
-
getPermissionsRaw
public long getPermissionsRaw()
Thelongrepresentation of the literal permissions that thisRolehas.- Returns:
- Never-negative long containing offset permissions of this role.
-
-