Class ParameterBuildingResult
Represents a a result of parameters building.
Namespace: TehGM.Wolfringo.Commands.Results
Assembly: Wolfringo.Commands.dll
Syntax
public class ParameterBuildingResult : IMessagesCommandResult, ICommandResultConstructors
| Improve this Doc View SourceParameterBuildingResult(Boolean, Object[], IEnumerable<String>)
Creates a new result instance.
Declaration
public ParameterBuildingResult(bool isSuccess, object[] values, IEnumerable<string> messages)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | isSuccess | Whether check was successful. |
| Object[] | values | Values for parameters that were built. |
| IEnumerable<String> | messages | Set of messages to reply with. |
Properties
| Improve this Doc View SourceIsSuccess
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.
Messages
Set of messages to reply with.
Declaration
public IEnumerable<string> Messages { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<String> |
Status
Status telling commands service how to progress with the execution.
Declaration
public CommandResultStatus Status { get; }Property Value
| Type | Description |
|---|---|
| CommandResultStatus |
Values
Values for parameters that were built.
Declaration
public object[] Values { get; }Property Value
| Type | Description |
|---|---|
| Object[] |
Methods
| Improve this Doc View SourceFailure(IEnumerable<String>)
Creates a failure result.
Declaration
public static ParameterBuildingResult Failure(IEnumerable<string> messages = null)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<String> | messages | Optional set of messages to reply with. |
Returns
| Type | Description |
|---|---|
| ParameterBuildingResult | A new result instance. |
Success(Object[], IEnumerable<String>)
Creates a success result.
Declaration
public static ParameterBuildingResult Success(object[] values, IEnumerable<string> messages = null)Parameters
| Type | Name | Description |
|---|---|---|
| Object[] | values | Values for parameters that were built. |
| IEnumerable<String> | messages | Optional set of messages to reply with. |
Returns
| Type | Description |
|---|---|
| ParameterBuildingResult | A new result instance. |