HttpCommandOptions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Optional configuration for resource HTTP commands added with WithHttpCommand<TResource>(IResourceBuilder<TResource>, String, String, String, String, HttpCommandOptions)."/>
public class HttpCommandOptions : Aspire.Hosting.ApplicationModel.CommandOptionstype HttpCommandOptions = class
inherit CommandOptionsPublic Class HttpCommandOptions
Inherits CommandOptions- Inheritance
Constructors
| HttpCommandOptions() |
Properties
| ConfirmationMessage |
When a confirmation message is specified, the UI will prompt with an OK/Cancel dialog and the confirmation message before starting the command. (Inherited from CommandOptions) |
| Description |
Optional description of the command, to be shown in the UI. Could be used as a tooltip. May be localized. (Inherited from CommandOptions) |
| EndpointSelector |
Gets or sets a callback that selects the HTTP endpoint to send the request to when the command is invoked. |
| GetCommandResult |
Gets or sets a callback to be invoked after the response is received to determine the result of the command invocation. |
| HttpClientName |
Gets or sets the name of the HTTP client to use when creating it via CreateClient(String). |
| IconName |
The icon name for the command. The name should be a valid FluentUI icon name from https://aka.ms/fluentui-system-icons. (Inherited from CommandOptions) |
| IconVariant |
The icon variant. (Inherited from CommandOptions) |
| IsHighlighted |
A flag indicating whether the command is highlighted in the UI. (Inherited from CommandOptions) |
| Method |
Gets or sets the HTTP method to use when sending the request. |
| Parameter |
Optional parameter that configures the command in some way. Clients must return any value provided by the server when invoking the command. (Inherited from CommandOptions) |
| PrepareRequest |
Gets or sets a callback to be invoked to configure the request before it is sent. |
| UpdateState |
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. (Inherited from CommandOptions) |