Class CommandParameterInfo

Namespace

HeyBox.Interactions

Assembly

HeyBox.Net.Interactions.dll

表示 InteractionService 命令的基础参数信息类。

public class CommandParameterInfo : IParameterInfo

Inheritance

object

CommandParameterInfo

Implements

IParameterInfo

Derived

SlashCommandParameterInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Attributes

获取此参数的特性集合。

public IReadOnlyCollection<Attribute> Attributes { get; }

Property Value

IReadOnlyCollection<Attribute>

Command

获取此参数所属的命令。

public ICommandInfo Command { get; }

Property Value

ICommandInfo

DefaultValue

获取此参数的默认值（如果为可选参数）。

public object? DefaultValue { get; }

Property Value

object

IsParameterArray

获取此参数是否被 params 关键字标记。

public bool IsParameterArray { get; }

Property Value

bool

IsRequired

获取此参数是否为必填项。

public bool IsRequired { get; }

Property Value

bool

Name

获取此参数的名称。

public string Name { get; }

Property Value

string

ParameterType

获取此参数的类型。

public Type ParameterType { get; }

Property Value

Type

Preconditions

获取此参数的先决条件集合。

public IReadOnlyCollection<ParameterPreconditionAttribute> Preconditions { get; }

Property Value

IReadOnlyCollection<ParameterPreconditionAttribute>

Methods

CheckPreconditionsAsync(IInteractionContext, object?, IServiceProvider?)

检查执行上下文是否满足参数的先决条件要求。

public Task<PreconditionResult> CheckPreconditionsAsync(IInteractionContext context, object? value, IServiceProvider? services)

Parameters

context IInteractionContext

value object

services IServiceProvider

Returns

Task<PreconditionResult>