Class PreconditionResult

Namespace

Kook.Commands

Assembly

Kook.Net.Commands.dll

表示一个命令的先决条件检查结果。

public class PreconditionResult : IResult

Inheritance

object

PreconditionResult

Implements

IResult

Derived

PreconditionGroupResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

PreconditionResult(CommandError?, string?)

初始化一个包含指定错误类型和原因的 PreconditionResult 类的新实例。

protected PreconditionResult(CommandError? error, string? errorReason)

Parameters

error CommandError?

错误类型。

errorReason string

错误原因。

Properties

Error

获取在命令执行期间发生的异常信息，如果没有异常则为 null。

public CommandError? Error { get; }

Property Value

CommandError?

ErrorReason

获取在命令执行期间发生的异常的原因，如果没有异常则为 null。

public string? ErrorReason { get; }

Property Value

string

IsSuccess

获取命令执行的结果是否为成功。

public bool IsSuccess { get; }

Property Value

bool

Methods

FromError(IResult)

初始化一个包含指定结果的 PreconditionResult 类的新实例，表示一个失败的先决条件检查。

public static PreconditionResult FromError(IResult result)

Parameters

result IResult

要包装的结果。

Returns

PreconditionResult

一个表示先决条件检查失败的 PreconditionResult。

FromError(Exception)

初始化一个包含指定错误类型和原因的 PreconditionResult 类的新实例，表示一个失败的先决条件检查。

public static PreconditionResult FromError(Exception ex)

Parameters

ex Exception

导致先决条件检查失败的异常。

Returns

PreconditionResult

一个表示先决条件检查失败的 PreconditionResult。

FromError(string)

初始化一个包含指定错误类型和原因的 PreconditionResult 类的新实例，表示一个失败的先决条件检查。

public static PreconditionResult FromError(string reason)

Parameters

reason string

错误原因。

Returns

PreconditionResult

一个表示先决条件检查失败的 PreconditionResult。

FromSuccess()

初始化一个不包含任何错误的 PreconditionResult 类的新实例，表示一个成功的先决条件检查。

public static PreconditionResult FromSuccess()

Returns

PreconditionResult

一个表示先决条件检查成功的 PreconditionResult。

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.