Role class
A role in a Guild.
External references:
- Discord API Reference: https://discord.com/developers/docs/topics/permissions#role-object
- Inheritance
- Implemented types
Properties
- color → DiscordColor
-
The color of this role.
final
- flags → RoleFlags
-
This role's flags.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- icon → CdnAsset?
-
This role's icon.
no setter
- iconHash → String?
-
The hash string of this role's icon.
final
- id → Snowflake
-
The id of this entity.
finalinherited
- isHoisted → bool
-
Whether this role is displayed separately from others in the member list.
final
- isMentionable → bool
-
Whether this role is mentionable.
final
- manager → RoleManager
-
The manager for this entity.
finalinherited
- name → String
-
The name of this role.
final
- permissions → Permissions
-
The permissions granted to this role at a guild level.
final
- position → int
-
The position of this role.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
The tags associated with this role.
final
- unicodeEmoji → String?
-
The unicode emoji for this role.
final
Methods
-
defaultToString(
) → String -
Same as toString, but only called when dart:mirrors is not available.
inherited
-
delete(
{String? auditLogReason}) → Future< void> -
Delete this role.
inherited
-
fetch(
) → Future< Role> -
Fetch this entity from the API.
inherited
-
get(
) → Future< Role> -
If this entity exists in the manager's cache, return the cached instance. Otherwise, fetch
this entity and return it.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
covariant RoleUpdateBuilder builder, {String? auditLogReason}) → Future< Role> -
Update this role, returning the updated role.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited