Class RegexCommandMatchResult

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

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

Constructors

| Improve this Doc View Source

RegexCommandMatchResult(CommandResultStatus, Match, CommandContextOptions)

Creates a new result instance.

Declaration
public RegexCommandMatchResult(CommandResultStatus status, Match regexMatch, CommandContextOptions options)
Parameters
Type Name Description
CommandResultStatus status

Status telling Command Service how to proceed.
Match regexMatch

Result of regex match.
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 RegexCommandMatchResult Skip
Field Value
Type Description
RegexCommandMatchResult

Properties

| 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
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

RegexMatch

Result of regex match.

Declaration
public Match RegexMatch { get; }
Property Value
Type Description
Match
| 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(Match, CommandContextOptions)

Creates a success result.

Declaration
public static RegexCommandMatchResult Success(Match regexMatch, CommandContextOptions options)
Parameters
Type Name Description
Match regexMatch

Result of regex match.
CommandContextOptions options

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

Implements

ICommandResult