ResourceCommandSnapshot Constructors

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

Constructors

Docs Reference Search C# APIs Aspire.Hosting ResourceCommandSnapshot Constructors

RecordConstructors1 member

A snapshot of a resource command.

Constructor(string, ResourceCommandState, string, string?, object?, string?, string?, IconVariant?, bool)

A snapshot of a resource command.

public record ResourceCommandSnapshot
{
    public ResourceCommandSnapshot(
        string Name,
        ResourceCommandState State,
        string DisplayName,
        string? DisplayDescription,
        object? Parameter,
        string? ConfirmationMessage,
        string? IconName,
        IconVariant? IconVariant,
        bool IsHighlighted)
    {
        // ...
    }
}

CustomResourceSnapshot.cs#L296-L308

Parameters

NamestringThe name of command. The name uniquely identifies the command.

StateResourceCommandStateThe state of the command.

DisplayNamestringThe display name visible in UI for the command.

DisplayDescriptionstring? Optional description of the command, to be shown in the UI. Could be used as a tooltip. May be localized.

Parameterobject? Obsolete optional parameter that configures the command in some way. Clients must return any value provided by the server when invoking the command.

ConfirmationMessagestring? When a confirmation message is specified, the UI will prompt with an OK/Cancel dialog and the confirmation message before starting the command.

IconNamestring?The icon name for the command. The name should be a valid FluentUI icon name. https://aka.ms/fluentui-system-icons

IconVariantIconVariant?The icon variant.

IsHighlightedboolA flag indicating whether the command is highlighted in the UI.