Interface ICommandBuilder

Namespace

HeyBox.Interactions.Builders

Assembly

HeyBox.Net.Interactions.dll

表示用于创建 ICommandInfo 的命令生成器。

public interface ICommandBuilder

Properties

Attributes

获取此命令的特性集合。

IReadOnlyList<Attribute> Attributes { get; }

Property Value

IReadOnlyList<Attribute>

Callback

获取此命令的执行委托。

ExecuteCallback? Callback { get; }

Property Value

ExecuteCallback

MethodName

获取或设置此命令的方法名。

string? MethodName { get; set; }

Property Value

string

Module

获取此命令的父模块。

ModuleBuilder Module { get; }

Property Value

ModuleBuilder

Name

获取此命令的名称。

string? Name { get; }

Property Value

string

Parameters

获取此命令的参数集合。

IReadOnlyList<IParameterBuilder> Parameters { get; }

Property Value

IReadOnlyList<IParameterBuilder>

Preconditions

获取此命令的先决条件集合。

IReadOnlyList<PreconditionAttribute> Preconditions { get; }

Property Value

IReadOnlyList<PreconditionAttribute>

RunMode

获取或设置此命令的运行模式。

RunMode RunMode { get; set; }

Property Value

RunMode

TreatNameAsRegex

获取或设置 Name 是否应直接作为正则表达式模式使用。

bool TreatNameAsRegex { get; set; }

Property Value

bool

Methods

AddParameters(params IParameterBuilder[])

向 Parameters 添加参数生成器。

ICommandBuilder AddParameters(params IParameterBuilder[] parameters)

Parameters

parameters IParameterBuilder[]

要添加到 Parameters 的新参数生成器。

Returns

ICommandBuilder

生成器实例。

SetRunMode(RunMode)

设置 RunMode。

ICommandBuilder SetRunMode(RunMode runMode)

Parameters

runMode RunMode

RunMode 的新值。

Returns

ICommandBuilder

生成器实例。

WithAttributes(params Attribute[])

向 Attributes 添加特性。

ICommandBuilder WithAttributes(params Attribute[] attributes)

Parameters

attributes Attribute[]

要添加到 Attributes 的新特性。

Returns

ICommandBuilder

生成器实例。

WithMethodName(string)

设置 MethodName。

ICommandBuilder WithMethodName(string name)

Parameters

name string

MethodName 的新值。

Returns

ICommandBuilder

生成器实例。

WithName(string)

设置 Name。

ICommandBuilder WithName(string name)

Parameters

name string

Name 的新值。

Returns

ICommandBuilder

生成器实例。

WithNameAsRegex(bool)

设置 TreatNameAsRegex。

ICommandBuilder WithNameAsRegex(bool value)

Parameters

value bool

TreatNameAsRegex 的新值。

Returns

ICommandBuilder

生成器实例。

WithPreconditions(params PreconditionAttribute[])

向 Preconditions 添加先决条件。

ICommandBuilder WithPreconditions(params PreconditionAttribute[] preconditions)

Parameters

preconditions PreconditionAttribute[]

要添加到 Preconditions 的新先决条件。

Returns

ICommandBuilder

生成器实例。