Class DoHierarchyCheckAttribute

Namespace

Discord.Interactions

Assembly

Discord.Net.Interactions.dll

Ensures that command parameters are passed within a correct hierarchical context.

public class DoHierarchyCheckAttribute : ParameterPreconditionAttribute

Inheritance

object

Attribute

ParameterPreconditionAttribute

DoHierarchyCheckAttribute

Inherited Members

Attribute.Equals(object)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, bool)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, bool)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, bool)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, bool)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, bool)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, bool)

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, bool)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, bool)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, bool)

Attribute.GetHashCode()

Attribute.IsDefaultAttribute()

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, bool)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, bool)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, bool)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, bool)

Attribute.Match(object)

Attribute.TypeId

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Useful for performing hierarchical operations within a guild, such as managing roles or users.

warning

This supports IRole, IGuildUser, and IUser parameter types.

Properties

ErrorMessage

Gets the error message to be returned if execution context doesn't pass the precondition check.

public override string ErrorMessage { get; }

Property Value

string

Remarks

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.

Exceptions

ArgumentOutOfRangeException

Thrown when the parameter type is not supported by this precondition attribute.

NotAGuildErrorMessage

Gets or sets the error message displayed when the command is used outside of a guild.

public string NotAGuildErrorMessage { get; set; }

Property Value

string

Exceptions

ArgumentOutOfRangeException

Thrown when the parameter type is not supported by this precondition attribute.

Methods

CheckRequirementsAsync(IInteractionContext, IParameterInfo, object, IServiceProvider)

Checks whether the condition is met before execution of the command.

public override Task<PreconditionResult> CheckRequirementsAsync(IInteractionContext context, IParameterInfo parameterInfo, object value, IServiceProvider services)

Parameters

context IInteractionContext

The context of the command.

parameterInfo IParameterInfo

The parameter of the command being checked against.

value object

The raw value of the parameter.

services IServiceProvider

The service collection used for dependency injection.

Returns

Task<PreconditionResult>

Exceptions

ArgumentOutOfRangeException

Thrown when the parameter type is not supported by this precondition attribute.

See Also

RequireRoleAttribute

RequireBotPermissionAttribute

RequireUserPermissionAttribute