Role class

Inheritance
Implemented types

Properties

client INyxx
Reference to client
final
color DiscordColor
The role's color, 0 if no color.
latefinal
createdAt DateTime
Gets creation timestamp included in Snowflake
no setterinherited
guild Cacheable<Snowflake, Guild>
Cacheable or guild attached to this role instance
latefinal
hashCode int
The hash code for this object.
no setterinherited
hoist bool
If the role is pinned in the user listing.
latefinal
iconEmoji String?
Emoji that represents role. For now emoji data is not validated and this can be any arbitrary string
latefinal
iconHash String?
Hash of role icon
latefinal
id Snowflake
ID of entity as Snowflake
finalinherited
managed bool
Whether or not the role is managed by an integration.
latefinal
mention String
Mention of role. If role cannot be mentioned it returns name of role (@name)
no setteroverride
mentionable bool
Whether or not the role is mentionable.
latefinal
name String
The role's name.
latefinal
permissions Permissions
The role's permissions.
latefinal
position int
The role's position.
latefinal
roleTags RoleTags?
Additional role data like if role is managed by integration or role is from server boosting.
latefinal
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

delete() Future<void>
Deletes the role.
edit(RoleBuilder role, {String? auditReason}) Future<Role>
Edits the role.
iconURL({String format = "webp", int size = 128}) String?
Returns url to role icon
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(dynamic other) bool
The equality operator.
inherited