CommandResults Methods

Canceled static ExecuteCommandResult

Produces a canceled result.

public static class CommandResults
{
    public static ExecuteCommandResult Canceled()
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L188

Failure(string?) static ExecuteCommandResult

Produces an unsuccessful result with an error message.

public static class CommandResults
{
    public static ExecuteCommandResult Failure(
        string? errorMessage = null)
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L168

Parameters

errorMessage string? optional An optional error message.

Failure(string, string, CommandResultFormat) static ExecuteCommandResult

Produces an unsuccessful result with an error message and result data.

public static class CommandResults
{
    public static ExecuteCommandResult Failure(
        string errorMessage,
        string result,
        CommandResultFormat resultFormat = CommandResultFormat.Text)
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L176

Parameters

errorMessage string The error message.

result string The result data.

resultFormat CommandResultFormat optional The format of the result data. Defaults to CommandResultFormat.Text.

Failure(string, CommandResultData) static ExecuteCommandResult

Produces an unsuccessful result with an error message and a value.

public static class CommandResults
{
    public static ExecuteCommandResult Failure(
        string errorMessage,
        CommandResultData value)
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L183

Parameters

errorMessage string The error message.

value CommandResultData The value produced by the command.

Failure(Exception) static ExecuteCommandResult

Produces an unsuccessful result from an Exception. Exception.Message is used as the error message.

public static class CommandResults
{
    public static ExecuteCommandResult Failure(
        Exception exception)
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L194

Parameters

exception Exception The exception to get the error message from.

Success static ExecuteCommandResult

Produces a success result.

public static class CommandResults
{
    public static ExecuteCommandResult Success()
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L147

Success(string, string, CommandResultFormat) static ExecuteCommandResult

Produces a success result with a message and result data.

public static class CommandResults
{
    public static ExecuteCommandResult Success(
        string message,
        string result,
        CommandResultFormat resultFormat = CommandResultFormat.Text)
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L155

Parameters

message string The message associated with the result.

result string The result data.

resultFormat CommandResultFormat optional The format of the result data. Defaults to CommandResultFormat.Text.

Success(string, CommandResultData) static ExecuteCommandResult

Produces a success result with a message and a value.

public static class CommandResults
{
    public static ExecuteCommandResult Success(
        string message,
        CommandResultData value)
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L162

Parameters

message string The message associated with the result.

value CommandResultData The value produced by the command.