RoleCheck class

A check that checks that the user that executes a command has a specific role.

Inheritance

Constructors

RoleCheck(Role role, {String? name})
Create a new RoleCheck that succeeds if the user that created the context has role.
RoleCheck.any(Iterable<Role> roles, {String? name})
Create a new RoleCheck that succeeds if the user that created the context has any of roles.
RoleCheck.anyId(Iterable<Snowflake> roles, {String? name})
Create a new RoleCheck that succeeds if the user that created the context has any role for which the role's id is in roles.
RoleCheck.id(Snowflake id, {String? name})
Create a new RoleCheck that succeeds if the user that created the context has a role with the id id.

Properties

allowsDm → FutureOr<bool>
Whether this check will allow commands to be executed in DM channels.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
name → String
The name of this check.
finalinherited
postCallHooks → Iterable<void Function(CommandContext context)>
An iterable of callbacks executed after a command is executed.
no setterinherited
preCallHooks → Iterable<void Function(CommandContext context)>
An iterable of callbacks executed before a command is executed but after all the checks for that command have succeeded.
no setterinherited
requiredPermissions → FutureOr<Flags<Permissions>?>
The permissions required from members to pass this check.
finalinherited
roleIds ↔ Iterable<Snowflake>
The IDs of the roles this check allows.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

check(CommandContext context) → FutureOr<bool>
Validate context against this check.
inherited
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 ==(Object other) → bool
The equality operator.
inherited