CommandResults Methods

Canceled static ExecuteCommandResult

Produces a canceled result.

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

ResourceCommandAnnotation.cs#L279

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

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

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

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

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

Success(string) static ExecuteCommandResult

Produces a success result.

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

ResourceCommandAnnotation.cs#L224

Parameters

message string

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

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, string, CommandResultFormat, bool) 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,
        bool displayImmediately)
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L246

Parameters

message string The message associated with the result.

result string The result data.

resultFormat CommandResultFormat The format of the result data.

displayImmediately bool A value indicating whether the result data should be displayed immediately in the dashboard.

Remarks

When displayImmediately is true, the dashboard opens the result dialog automatically when the command completes. Other clients can still read the result data from ExecuteCommandResult.Data.

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

Parameters

message string The message associated with the result.

value CommandResultData The value produced by the command.