Struct CommandMatch

Namespace

Kook.Commands

Assembly

Kook.Net.Commands.dll

表示一个匹配的命令。

public struct CommandMatch

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

CommandMatch(CommandInfo, string)

初始化一个 CommandMatch 结构的新实例。

public CommandMatch(CommandInfo command, string alias)

Parameters

command CommandInfo

与搜索结果相匹配的命令。

alias string

命令的别名。

Properties

Alias

获取命令的别名。

public readonly string Alias { get; }

Property Value

string

Command

获取与搜索结果相匹配的命令。

public readonly CommandInfo Command { get; }

Property Value

CommandInfo

Methods

CheckPreconditionsAsync(ICommandContext, IServiceProvider?)

检查此命令的先决条件。

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

Parameters

context ICommandContext

命令的上下文。

services IServiceProvider

用于检查先决条件的以来服务提供程序。

Returns

Task<PreconditionResult>

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

ExecuteAsync(ICommandContext, ParseResult, IServiceProvider)

执行此命令。

public Task<IResult> ExecuteAsync(ICommandContext context, ParseResult parseResult, IServiceProvider services)

Parameters

context ICommandContext

命令的上下文。

parseResult ParseResult

解析的结果。

services IServiceProvider

用于执行的服务提供程序。

Returns

Task<IResult>

一个表示异步执行操作的任务。任务的结果包含执行的结果。

ExecuteAsync(ICommandContext, IEnumerable<object>, IEnumerable<object>, IServiceProvider)

执行此命令。

public Task<IResult> ExecuteAsync(ICommandContext context, IEnumerable<object> argList, IEnumerable<object> paramList, IServiceProvider services)

Parameters

context ICommandContext

命令的上下文。

argList IEnumerable<object>

命令的实参。

paramList IEnumerable<object>

命令的形参。

services IServiceProvider

用于执行的服务提供程序。

Returns

Task<IResult>

一个表示异步执行操作的任务。任务的结果包含执行的结果。

ParseAsync(ICommandContext, SearchResult, PreconditionResult?, IServiceProvider?)

解析此命令。

public Task<ParseResult> ParseAsync(ICommandContext context, SearchResult searchResult, PreconditionResult? preconditionResult = null, IServiceProvider? services = null)

Parameters

context ICommandContext

命令的上下文。

searchResult SearchResult

搜索结果。

preconditionResult PreconditionResult

先决条件的结果。

services IServiceProvider

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

Returns

Task<ParseResult>

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