CommandOptions
Classnet8.0
Optional configuration for resource commands added with
ResourceBuilderExtensions.WithCommand. namespace Aspire.Hosting.ApplicationModel;
public class CommandOptions{ // ...}11 members
Constructors1
Section titled ConstructorsProperties10
Section titled PropertiesArgumentsget; setexperimental Gets or sets the invocation arguments accepted by the command.
ConfirmationMessageget; setstring? When a confirmation message is specified, the UI will prompt with an OK/Cancel dialog and the confirmation message before starting the command.
Descriptionget; setstring? Optional description of the command, to be shown in the UI. Could be used as a tooltip. May be localized.
IconNameget; setstring? The icon name for the command. The name should be a valid FluentUI icon name from https://aka.ms/fluentui-system-icons.
IconVariantget; set The icon variant.
IsHighlightedget; setbool A flag indicating whether the command is highlighted in the UI.
Parameterget; setobsoleteobject? Obsolete optional parameter that configures the command in some way. Clients must return any value provided by the server when invoking the command.
UpdateStateget; setFunc<UpdateCommandStateContext, ResourceCommandState>A callback that is used to update the command state. The callback is executed when the command's resource snapshot is updated.
If a callback isn't specified, the command is always enabled.
ValidateArgumentsget; setexperimentalFunc<InputsDialogValidationContext, Task> Gets or sets the callback that validates invocation arguments before the command callback is executed.
Visibilityget; set Gets or sets where the command is visible to users and clients.