Class ParameterBuildingResult

Represents a a result of parameters building.

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

Constructors

| Improve this Doc View Source

ParameterBuildingResult(Boolean, Object[], IEnumerable<String>)

Creates a new result instance.

Declaration
public ParameterBuildingResult(bool isSuccess, object[] values, IEnumerable<string> messages)
Parameters
Type Name Description
System.Boolean isSuccess

Whether check was successful.
System.Object[] values

Values for parameters that were built.
System.Collections.Generic.IEnumerable<System.String> messages

Set of messages to reply with.

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
System.Boolean
Remarks

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

| Improve this Doc View Source

Messages

Set of messages to reply with.

Declaration
public IEnumerable<string> Messages { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>
| 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
| Improve this Doc View Source

Values

Values for parameters that were built.

Declaration
public object[] Values { get; }
Property Value
Type Description
System.Object[]

Methods

| Improve this Doc View Source

Failure(IEnumerable<String>)

Creates a failure result.

Declaration
public static ParameterBuildingResult Failure(IEnumerable<string> messages = null)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> messages

Optional set of messages to reply with.
Returns
Type Description
ParameterBuildingResult

A new result instance.
| Improve this Doc View Source

Success(Object[], IEnumerable<String>)

Creates a success result.

Declaration
public static ParameterBuildingResult Success(object[] values, IEnumerable<string> messages = null)
Parameters
Type Name Description
System.Object[] values

Values for parameters that were built.
System.Collections.Generic.IEnumerable<System.String> messages

Optional set of messages to reply with.
Returns
Type Description
ParameterBuildingResult

A new result instance.

Implements

IMessagesCommandResult
ICommandResult