Skip to content
SinisterRectus edited this page Mar 4, 2017 · 21 revisions

Represents a Discord guild role.

Properties Inherited From Container

Name Type Mutable Description
client Client Client object to which the Discord object is known
parent * Parent Discord object

Properties Inherited From Snowflake

Name Type Mutable Description
createdAt number Unix time in seconds at which the object was created by Discord
id string Snowflake ID for the object
timestamp string ISO 8601 date and time at which the object was created by Discord

Class Properties

Name Type Mutable Description
color Color X Object representing the role color
guild Guild Discord guild in which the role exists
hoist boolean X Whether members with this role are displayed separated from others
managed boolean Whether the role is managed by an integration
mentionString string Raw string that is parsed by Discord into a role mention
mentionable boolean X Whether guild members can mention this role
name string X Role name
permissions Permissions X Object representing the role's permissions
position number X The position setting of the guild's list of roles

Class Methods

Prototype Interface Description
delete() HTTP Permanently deletes the role.
disableAllPermissions() HTTP Disables all permissions for the role.
disablePermissions(flag[, ...]) HTTP Disables permissions for the role by flag.
enableAllPermissions() HTTP Enables all permissions for the role.
enablePermissions(flag[, ...]) HTTP Enables permissions for the role by flag.

Clone this wiki locally