IRole class abstract

Implemented types

Constructors

IRole()

Properties

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

Methods

delete() Future<void>
Deletes the role.
edit(RoleBuilder role, {String? auditReason}) Future<IRole>
Edits the role.
iconUrl({String format = 'webp', int? size}) 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