Class ParameterInfo

Namespace

Kook.Commands

Assembly

Kook.Net.Commands.dll

表示一个参数的信息。

public class ParameterInfo

Inheritance

object

ParameterInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Attributes

获取此参数的所有特性。

public IReadOnlyList<Attribute> Attributes { get; }

Property Value

IReadOnlyList<Attribute>

Command

获取此参数所属的命令。

public CommandInfo Command { get; }

Property Value

CommandInfo

DefaultValue

获取此参数的默认值。

public object? DefaultValue { get; }

Property Value

object

IsMultiple

获取此参数是否为多值参数。

public bool IsMultiple { get; }

Property Value

bool

IsOptional

获取此参数是否为可选参数。

public bool IsOptional { get; }

Property Value

bool

IsRemainder

获取此参数是否接收全部剩余参数。

public bool IsRemainder { get; }

Property Value

bool

Name

获取此参数的名称。

public string Name { get; }

Property Value

string

Preconditions

获取此参数的所有先决条件。

public IReadOnlyList<ParameterPreconditionAttribute> Preconditions { get; }

Property Value

IReadOnlyList<ParameterPreconditionAttribute>

Summary

获取此参数的摘要。

public string? Summary { get; }

Property Value

string

Type

获取此参数的类型。

public Type? Type { get; }

Property Value

Type

Methods

CheckPreconditionsAsync(ICommandContext, object?, IServiceProvider?)

检查此参数是否满足其先决条件。

public Task<PreconditionResult> CheckPreconditionsAsync(ICommandContext context, object? arg, IServiceProvider? services = null)

Parameters

context ICommandContext

命令的上下文。

arg object

参数的值。

services IServiceProvider

用于解析服务的服务提供程序。

Returns

Task<PreconditionResult>

一个表示异步检查操作的任务。任务的结果包含先决条件的结果。

ParseAsync(ICommandContext, string, IServiceProvider?)

解析字符串输入为此参数目标类型的值。

public Task<TypeReaderResult> ParseAsync(ICommandContext context, string input, IServiceProvider? services = null)

Parameters

context ICommandContext

命令的上下文。

input string

要解析的字符串输入。

services IServiceProvider

用于解析服务的服务提供程序。

Returns

Task<TypeReaderResult>

一个表示异步解析操作的任务。任务的结果包含参数解析的结果。

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.