Class RequireUserPrivilegeAttribute

Command requirement that checks if the user has correct privileges.

Inheritance
Object
Attribute
CommandRequirementAttribute
RequireUserPrivilegeAttribute
RequireUserEntertainerAttribute
RequireUserStaffAttribute
RequireUserVolunteerAttribute
Implements
Inherited Members
Namespace: TehGM.Wolfringo.Commands.Attributes
Assembly: Wolfringo.Commands.dll
Syntax
public class RequireUserPrivilegeAttribute : CommandRequirementAttribute, ICommandRequirement
Remarks

Default ErrorMessage for this requirement is "(n) You don't have enough user privileges to execute this command.".

Constructors

| Improve this Doc View Source

RequireUserPrivilegeAttribute(WolfPrivilege)

Creates a new instance of command user privilege requirement.

Declaration
public RequireUserPrivilegeAttribute(WolfPrivilege privileges)
Parameters
Type Name Description
WolfPrivilege privileges

Flags of privileges that fulfill this requirement.
Remarks

Only one of the privileges has to match. For example, Volunteer | Staff matches if user is either Volunteer or Staff.

See Also

Properties

| Improve this Doc View Source

Privileges

Flags of privileges that fulfill this requirement.

Declaration
public WolfPrivilege Privileges { get; }
Property Value
Type Description
WolfPrivilege
Remarks

Only one of the privileges has to match. For example, Volunteer | Staff matches if user is either Volunteer or Staff.

Methods

| Improve this Doc View Source

CheckAsync(ICommandContext, IServiceProvider, CancellationToken)

Checks requirement.

Declaration
public override async Task<ICommandResult> CheckAsync(ICommandContext context, IServiceProvider services, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
ICommandContext context

Command to check the requirement for.
IServiceProvider services

Services that can be used during requirement checks.
CancellationToken cancellationToken

Token for cancelling the task.
Returns
Type Description
Task<ICommandResult>

True if requirement was fullfilled; otherwise false.
Overrides
CommandRequirementAttribute.CheckAsync(ICommandContext, IServiceProvider, CancellationToken)
| Improve this Doc View Source

CheckPrivilegeAsync(ICommandContext, UInt32, WolfPrivilege, CancellationToken)

Checks if user has a specified privilege.

Declaration
public static async Task<bool> CheckPrivilegeAsync(ICommandContext context, uint userID, WolfPrivilege privileges, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
ICommandContext context

Context of the command execution.
UInt32 userID

ID of the user.
WolfPrivilege privileges

Required privileges flags.
CancellationToken cancellationToken

Cancellation token for cancelling the task.
Returns
Type Description
Task<Boolean>

True if user has at least one of specified privileges; otherwise false.

Implements

ICommandRequirement