You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
40 lines
1.8 KiB
40 lines
1.8 KiB
using System;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Discord.Commands
|
|
{
|
|
/// <summary>
|
|
/// Requires the module or class to pass the specified precondition before execution can begin.
|
|
/// </summary>
|
|
/// <seealso cref="ParameterPreconditionAttribute"/>
|
|
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
|
|
public abstract class PreconditionAttribute : Attribute
|
|
{
|
|
/// <summary>
|
|
/// Specifies a group that this precondition belongs to.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <see cref="Preconditions" /> of the same group require only one of the preconditions to pass in order to
|
|
/// be successful (A || B). Specifying <see cref="Group" /> = <c>null</c> or not at all will
|
|
/// require *all* preconditions to pass, just like normal (A && B).
|
|
/// </remarks>
|
|
public string Group { get; set; } = null;
|
|
|
|
/// <summary>
|
|
/// When overridden in a derived class, uses the supplied string
|
|
/// as the error message if the precondition doesn't pass.
|
|
/// Setting this for a class that doesn't override
|
|
/// this property is a no-op.
|
|
/// </summary>
|
|
public virtual string ErrorMessage { get { return null; } set { } }
|
|
|
|
/// <summary>
|
|
/// Checks if the <paramref name="command"/> has the sufficient permission to be executed.
|
|
/// </summary>
|
|
/// <param name="context">The context of the command.</param>
|
|
/// <param name="command">The command being executed.</param>
|
|
/// <param name="services">The service collection used for dependency injection.</param>
|
|
public abstract Task<PreconditionResult> CheckPermissionsAsync(ICommandContext context, CommandInfo command, IServiceProvider services);
|
|
}
|
|
}
|