PermissionsCheck class Null safety

A check that succeeds if the member invoking the command has a certain set of permissions.

You might also be interested in:

  • UserCheck, for checking if a command was executed by a specific user;
  • RoleCheck, for checking if a command was executed by a user with a specific role.
Inheritance

Constructors

PermissionsCheck(int permissionsValue, {bool allowsOverrides = true, bool requiresAll = false, String? name, bool allowsDm = true})
Create a new PermissionsCheck.
PermissionsCheck.nobody({bool allowsOverrides = true, String? name, bool allowsDm = true})
Create a PermissionsCheck that allows nobody to execute a command, unless configured otherwise by a permission override.

Properties

allowsDm FutureOr<bool>
Whether this check will allow commands to be executed in DM channels.
final, inherited
allowsOverrides bool
Whether this check should allow server administrators to configure overrides that allow specific users or channels to execute this command regardless of permissions.
final
hashCode int
The hash code for this object.
read-only, inherited
name String
The name of this check.
final, inherited
permissions Future<Iterable<CommandPermissionBuilderAbstract>>
The set of Discord Slash Command Permissions this check represents.
@Deprecated('Use allowsDm and requiredPermissions instead'), final, inherited
permissionsValue int
The bitfield representing the permissions required by this check.
final
postCallHooks Iterable<void Function(IContext context)>
An iterable of callbacks executed after a command is executed.
read-only, inherited
preCallHooks Iterable<void Function(IContext context)>
An iterable of callbacks executed before a command is executed but after all the checks for that command have succeeded.
read-only, inherited
requiredPermissions FutureOr<int?>
The permissions required from members to pass this check.
final, inherited
requiresAll bool
Whether this check requires the user invoking the command to have all of the permissions in permissionsValue or only a single permission from permissionsValue.
final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

check(IContext context) FutureOr<bool>
Validate context against this check.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

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