Class PreconditionResult

Namespace

HeyBox.Interactions

Assembly

HeyBox.Net.Interactions.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)

object.ToString()

Constructors

PreconditionResult(InteractionCommandError?, string?)

初始化一个新的 PreconditionResult，包含先决条件失败类型和原因。

protected PreconditionResult(InteractionCommandError? error, string? reason)

Parameters

error InteractionCommandError?

失败类型。

reason string

失败原因。

Properties

Error

获取操作过程中可能发生的错误类型。

public InteractionCommandError? Error { get; }

Property Value

InteractionCommandError?

一个 InteractionCommandError，指示操作过程中可能发生的错误类型； 如果操作成功，则为 null。

ErrorReason

获取错误原因。

public string? ErrorReason { get; }

Property Value

string

包含错误原因的字符串。

IsSuccess

指示操作是否成功。

public bool IsSuccess { get; }

Property Value

bool

如果结果为正，则为 true；否则为 false。

Methods

FromError(IResult)

获取一个表示失败的 PreconditionResult 实例。

public static PreconditionResult FromError(IResult result)

Parameters

result IResult

包含错误信息的结果。

Returns

PreconditionResult

FromError(Exception)

获取一个表示失败的 PreconditionResult 实例。

public static PreconditionResult FromError(Exception exception)

Parameters

exception Exception

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

Returns

PreconditionResult

FromError(string)

获取一个表示失败的 PreconditionResult 实例。

public static PreconditionResult FromError(string reason)

Parameters

reason string

先决条件检查失败的原因。

Returns

PreconditionResult

FromSuccess()

获取一个表示成功的 PreconditionResult 实例。

public static PreconditionResult FromSuccess()

Returns

PreconditionResult