ResourceCommandSnapshot Constructor

Definition

Namespace:

Aspire.Hosting.ApplicationModel

Assembly:

Aspire.Hosting.dll

Package:

Aspire.Hosting v9.0.0

Source:

CustomResourceSnapshot.cs

A snapshot of a resource command.

public ResourceCommandSnapshot (string Name, Aspire.Hosting.ApplicationModel.ResourceCommandState State, string DisplayName, string? DisplayDescription, object? Parameter, string? ConfirmationMessage, string? IconName, Aspire.Hosting.ApplicationModel.IconVariant? IconVariant, bool IsHighlighted);

new Aspire.Hosting.ApplicationModel.ResourceCommandSnapshot : string * Aspire.Hosting.ApplicationModel.ResourceCommandState * string * string * obj * string * string * Nullable<Aspire.Hosting.ApplicationModel.IconVariant> * bool -> Aspire.Hosting.ApplicationModel.ResourceCommandSnapshot

Public Sub New (Name As String, State As ResourceCommandState, DisplayName As String, DisplayDescription As String, Parameter As Object, ConfirmationMessage As String, IconName As String, IconVariant As Nullable(Of IconVariant), IsHighlighted As Boolean)

Parameters

Name

String

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

State

ResourceCommandState

The state of the command.

DisplayName

String

The display name visible in UI for the command.

DisplayDescription

String

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

Parameter

Object

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

ConfirmationMessage

String

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

IconName

String

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

IconVariant

Nullable<IconVariant>

The icon variant.

IsHighlighted

Boolean

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