Skip to content

Inherits
Object

Class Role

Represents a Role in a Guild.

Properties


Id

Gets the unique id of the role
Declaration

public int Id {get; }

Property Value

Type Description
Int32 The unique id of the role.

Name

Gets the name of the role.
Declaration

public string Name {get; }

Property Value

Type Description
String The name of the role.

Guild

Gets the Guild the role belongs to.
Declaration

public Guild Guild {get; }

Property Value

Type Description
Guild The guild the role belongs to.

Color

Gets the color of the role.
Declaration

public Color Color {get; }

Property Value

Type Description
Color The role's color.

Hoist

Checks if the role will be displayed separately from other members.
Declaration

public bool Hoist {get; }

Property Value

Type Description
Boolean true if it will be displayed separately, false otherwise.

Position

Gets the position of the role.
Declaration

public int Position {get; }

Remarks
Bottom role has a position of 0.
Property Value

Type Description
Int32 The position of the role.

Mentionable

Checks if the role can be mentioned by users.
Declaration

public bool Mentionable {get; }

Property Value

Type Description
Boolean true if it's mentionable, false otherwise.

IsDefault

Checks if the role is the guild's default role.
Declaration

public bool IsDefault {get; }

Property Value

Type Description
Boolean true if it is the default role, false otherwise.