Class StandardCommandMatchResult

Represents results of a check whether a Standard Command should run.

Inheritance
System.Object
StandardCommandMatchResult
Implements
Namespace: TehGM.Wolfringo.Commands.Results
Assembly: Wolfringo.Commands.dll
Syntax
public class StandardCommandMatchResult : ICommandResult

Constructors

| Improve this Doc View Source

StandardCommandMatchResult(CommandResultStatus, String, CommandContextOptions)

Creates a new result instance.

Declaration
public StandardCommandMatchResult(CommandResultStatus status, string argumentsText, CommandContextOptions options)
Parameters
Type Name Description
CommandResultStatus status

Status telling Command Service how to proceed.
System.String argumentsText

Found arguments.
CommandContextOptions options

Options for command context, with command's overrides applied.

Fields

| Improve this Doc View Source

Skip

Shared failure result.

Declaration
public static readonly StandardCommandMatchResult Skip
Field Value
Type Description
StandardCommandMatchResult

Properties

| Improve this Doc View Source

ArgumentsText

String containing un-parsed arguments.

Declaration
public string ArgumentsText { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsSuccess

Whether execution or check was successful.

Declaration
[Obsolete("Use Status property instead.")]
public bool IsSuccess { get; }
Property Value
Type Description
System.Boolean
Remarks

This property has been obsoleted in favour of Status and will be removed in future updates.

| Improve this Doc View Source

Options

Options for command context, with command's overrides applied.

Declaration
public CommandContextOptions Options { get; }
Property Value
Type Description
CommandContextOptions
| Improve this Doc View Source

Status

Status telling commands service how to progress with the execution.

Declaration
public CommandResultStatus Status { get; }
Property Value
Type Description
CommandResultStatus

Methods

| Improve this Doc View Source

Success(String, CommandContextOptions)

Creates a success result.

Declaration
public static StandardCommandMatchResult Success(string argumentsText, CommandContextOptions options)
Parameters
Type Name Description
System.String argumentsText

Found arguments.
CommandContextOptions options

Options for command context, with command's overrides applied.
Returns
Type Description
StandardCommandMatchResult

Implements

ICommandResult