UserCheck class Null safety
A check that checks that a command was executed by a specific user.
- Inheritance
-
- Object
- AbstractCheck
- Check
- UserCheck
Constructors
- UserCheck(IUser user, [String? name])
-
Create a new UserCheck that succeeds if the context was created by
user
. -
UserCheck.any(Iterable<
IUser> users, [String? name]) -
Create a new UserCheck that succeeds if the context was created by any one of
users
. -
UserCheck.anyId(Iterable<
Snowflake> ids, [String? name]) -
Create a new UserCheck that succeeds if the ID of the user that created the context is in
ids
. - UserCheck.id(Snowflake id, [String? name])
-
Create a new UserCheck that succeeds if the ID of the user that created the context is
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.
read-onlyinherited
- name → String
-
The name of this check.
finalinherited
-
permissions
→ Future<
Iterable< CommandPermissionBuilderAbstract> > -
The set of Discord Slash Command Permissions
this check represents.
finalinherited
-
postCallHooks
→ Iterable<
void Function(IContext context)> -
An iterable of callbacks executed after a command is executed.
read-onlyinherited
-
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-onlyinherited
-
requiredPermissions
→ FutureOr<
int?> -
The permissions required from members to pass this check.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
-
userIds
↔ Iterable<
Snowflake> -
The IDs of the users this check allows.
read / write
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