Class ParameterBuilder

Namespace

Kook.Commands.Builders

Assembly

Kook.Net.Commands.dll

表示一个参数构建器。

public class ParameterBuilder

Inheritance

object

ParameterBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Attributes

获取此参数的特性。

public IReadOnlyList<Attribute> Attributes { get; }

Property Value

IReadOnlyList<Attribute>

Command

获取此参数构建器所属的命令构建器。

public CommandBuilder Command { get; }

Property Value

CommandBuilder

DefaultValue

获取或设置此参数的默认值。

public object? DefaultValue { get; set; }

Property Value

object

IsMultiple

获取或设置此参数是否为多值参数。

public bool IsMultiple { get; set; }

Property Value

bool

IsOptional

获取或设置此参数是否为可选参数。

public bool IsOptional { get; set; }

Property Value

bool

IsRemainder

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

public bool IsRemainder { get; set; }

Property Value

bool

Name

获取或设置此参数的名称。

public string Name { get; }

Property Value

string

ParameterType

获取或设置此参数的类型。

public Type? ParameterType { get; }

Property Value

Type

Preconditions

获取此参数的先决条件。

public IReadOnlyList<ParameterPreconditionAttribute> Preconditions { get; }

Property Value

IReadOnlyList<ParameterPreconditionAttribute>

Summary

获取或设置此参数的摘要。

public string? Summary { get; set; }

Property Value

string

TypeReader

获取或设置此参数的类型读取器。

public TypeReader? TypeReader { get; set; }

Property Value

TypeReader

Methods

AddAttributes(params Attribute[])

添加特性到此参数。

public ParameterBuilder AddAttributes(params Attribute[] attributes)

Parameters

attributes Attribute[]

要添加到此参数的特性数组。

Returns

ParameterBuilder

此参数构建器。

AddPrecondition(ParameterPreconditionAttribute)

添加先决条件到此参数。

public ParameterBuilder AddPrecondition(ParameterPreconditionAttribute precondition)

Parameters

precondition ParameterPreconditionAttribute

要添加到此参数的先决条件。

Returns

ParameterBuilder

此参数构建器。

WithDefault(object)

设置此参数的默认值。

public ParameterBuilder WithDefault(object defaultValue)

Parameters

defaultValue object

此参数的默认值。

Returns

ParameterBuilder

此参数构建器。

WithIsMultiple(bool)

设置此参数是否为多值参数。

public ParameterBuilder WithIsMultiple(bool isMultiple)

Parameters

isMultiple bool

此参数是否为多值参数。

Returns

ParameterBuilder

此参数构建器。

WithIsOptional(bool)

设置此参数是否为可选参数。

public ParameterBuilder WithIsOptional(bool isOptional)

Parameters

isOptional bool

此参数是否为可选参数。

Returns

ParameterBuilder

此参数构建器。

WithIsRemainder(bool)

设置此参数是否接收全部剩余参数。

public ParameterBuilder WithIsRemainder(bool isRemainder)

Parameters

isRemainder bool

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

Returns

ParameterBuilder

此参数构建器。

WithSummary(string)

设置此参数的摘要。

public ParameterBuilder WithSummary(string summary)

Parameters

summary string

此参数的摘要。

Returns

ParameterBuilder

此参数构建器。