ResourceCommandAnnotation Constructors

Docs/Reference/Search C# APIs/Aspire.Hosting/ResourceCommandAnnotation/Constructors

Constructors

Docs Reference Search C# APIs Aspire.Hosting ResourceCommandAnnotation Constructors

ClassConstructors2 members

Represents a command annotation for a resource.

Constructor(string, string, Func<UpdateCommandStateContext, ResourceCommandState>, Func<ExecuteCommandContext, Task<ExecuteCommandResult>>, string?, object?, string?, string?, IconVariant?, bool)

Initializes a new instance of the ResourceCommandAnnotation class.

public sealed class ResourceCommandAnnotation
{
    public ResourceCommandAnnotation(
        string name,
        string displayName,
        Func<UpdateCommandStateContext, ResourceCommandState> updateState,
        Func<ExecuteCommandContext, Task<ExecuteCommandResult>> executeCommand,
        string? displayDescription,
        object? parameter,
        string? confirmationMessage,
        string? iconName,
        IconVariant? iconVariant,
        bool isHighlighted)
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L33-L35

Parameters

namestring

displayNamestring

updateStateFunc<UpdateCommandStateContext, ResourceCommandState>

executeCommandFunc<ExecuteCommandContext, Task<ExecuteCommandResult>>

displayDescriptionstring?

parameterobject?

confirmationMessagestring?

iconNamestring?

iconVariantIconVariant?

isHighlightedbool

Constructor(string, string, Func<UpdateCommandStateContext, ResourceCommandState>, Func<ExecuteCommandContext, Task<ExecuteCommandResult>>, string?, IReadOnlyList<InteractionInput>, string?, string?, IconVariant?, bool, ResourceCommandVisibility, Func<InputsDialogValidationContext, Task>)

Initializes a new instance of the ResourceCommandAnnotation class.

public sealed class ResourceCommandAnnotation
{
    public ResourceCommandAnnotation(
        string name,
        string displayName,
        Func<UpdateCommandStateContext, ResourceCommandState> updateState,
        Func<ExecuteCommandContext, Task<ExecuteCommandResult>> executeCommand,
        string? displayDescription,
        IReadOnlyList<InteractionInput>? arguments,
        string? confirmationMessage,
        string? iconName,
        IconVariant? iconVariant,
        bool isHighlighted,
        ResourceCommandVisibility visibility = ResourceCommandVisibility.UI | ResourceCommandVisibility.Api,
        Func<InputsDialogValidationContext, Task>? validateArguments = null)
    {
        // ...
    }
}

ResourceCommandAnnotation.cs#L53-L55

Parameters

namestring

displayNamestring

updateStateFunc<UpdateCommandStateContext, ResourceCommandState>

executeCommandFunc<ExecuteCommandContext, Task<ExecuteCommandResult>>

displayDescriptionstring?

argumentsIReadOnlyList<InteractionInput>

confirmationMessagestring?

iconNamestring?

iconVariantIconVariant?

isHighlightedbool

visibilityResourceCommandVisibilityoptional

validateArgumentsFunc<InputsDialogValidationContext, Task>optional