ResourceCommandSnapshot

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

ResourceCommandSnapshot

Docs Reference Search C# APIs Aspire.Hosting ResourceCommandSnapshot

Record sealed net10.0

📦 Aspire.Hosting v13.1.2

A snapshot of a resource command.

namespace Aspire.Hosting.ApplicationModel;

public sealed record ResourceCommandSnapshot
    : System.IEquatable<Aspire.Hosting.ApplicationModel.ResourceCommandSnapshot>
{
    // ...
}

IEquatable<ResourceCommandSnapshot>

Implements

• IEquatable<ResourceCommandSnapshot>

Source

Search members of ResourceCommandSnapshot...

constructor method property

18 members Clear filters

Constructors1

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

A snapshot of a resource command.

View all constructors

Properties9

ConfirmationMessageget; init

string?

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

DisplayDescriptionget; init

string?

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

DisplayNameget; init

string

The display name visible in UI for the command.

IconNameget; init

string?

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

IconVariantget; init

IconVariant?

The icon variant.

IsHighlightedget; init

bool

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

Nameget; init

string

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

Parameterget; init

object?

Optional parameter that configures the command in some way. Clients must return any value provided by the server when invoking the command.

Stateget; init

ResourceCommandState

The state of the command.

View all properties

Methods8

<Clone>$

ResourceCommandSnapshot

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

Equals(object?)

bool

Determines whether the specified object is equal to the current object.

Equals(ResourceCommandSnapshot?)

bool

Indicates whether the current object is equal to another object of the same type.

GetHashCode

int

Serves as the default hash function.

op_Equality(ResourceCommandSnapshot?, ResourceCommandSnapshot?)static

bool

op_Inequality(ResourceCommandSnapshot?, ResourceCommandSnapshot?)static

bool

ToString

string

Returns a string that represents the current object.

View all methods