Skip to content
Aspire
Docs Try Aspire
Docs Try

Install Aspire CLI

macOS

curl -sSL https://aspire.dev/install.sh | bash

Linux

curl -sSL https://aspire.dev/install.sh | bash

Windows

irm https://aspire.dev/install.ps1 | iex
More installation options

IInteractionService Methods

Interface Methods 6 members
A service to interact with the current development environment.
PromptConfirmationAsync(string, string, MessageBoxInteractionOptions?, CancellationToken) Section titled PromptConfirmationAsync(string, string, MessageBoxInteractionOptions?, CancellationToken) abstract Task<InteractionResult<bool>>
Prompts the user for confirmation with a dialog. 
public interface IInteractionService
{
    public abstract Task<InteractionResult<bool>> PromptConfirmationAsync(
        string title,
        string message,
        MessageBoxInteractionOptions? options = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}
Parameters
title string The title of the dialog.
message string The message to display in the dialog.
options MessageBoxInteractionOptions? optional Optional configuration for the message box interaction.
cancellationToken CancellationToken optional A token to cancel the operation.
Returns
Task<InteractionResult<bool>> An Hosting.InteractionResult`1 containing true if the user confirmed, false otherwise.
PromptInputAsync(string, string?, string, string, InputsDialogInteractionOptions?, CancellationToken) Section titled PromptInputAsync(string, string?, string, string, InputsDialogInteractionOptions?, CancellationToken) abstract Task<InteractionResult<InteractionInput>>
Prompts the user for a single text input. 
public interface IInteractionService
{
    public abstract Task<InteractionResult<InteractionInput>> PromptInputAsync(
        string title,
        string? message,
        string inputLabel,
        string placeHolder,
        InputsDialogInteractionOptions? options = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}
Parameters
title string The title of the input dialog.
message string? The message to display in the dialog.
inputLabel string The label for the input field.
placeHolder string The placeholder text for the input field.
options InputsDialogInteractionOptions? optional Optional configuration for the input dialog interaction.
cancellationToken CancellationToken optional A token to cancel the operation.
Returns
Task<InteractionResult<InteractionInput>> An Hosting.InteractionResult`1 containing the user's input.
PromptInputAsync(string, string?, InteractionInput, InputsDialogInteractionOptions?, CancellationToken) Section titled PromptInputAsync(string, string?, InteractionInput, InputsDialogInteractionOptions?, CancellationToken) abstract Task<InteractionResult<InteractionInput>>
Prompts the user for a single input using a specified InteractionInput. 
public interface IInteractionService
{
    public abstract Task<InteractionResult<InteractionInput>> PromptInputAsync(
        string title,
        string? message,
        InteractionInput input,
        InputsDialogInteractionOptions? options = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}
Parameters
title string The title of the input dialog.
message string? The message to display in the dialog.
input InteractionInput The input configuration.
options InputsDialogInteractionOptions? optional Optional configuration for the input dialog interaction.
cancellationToken CancellationToken optional A token to cancel the operation.
Returns
Task<InteractionResult<InteractionInput>> An Hosting.InteractionResult`1 containing the user's input.
PromptInputsAsync(string, string?, IReadOnlyList<InteractionInput>, InputsDialogInteractionOptions?, CancellationToken) Section titled PromptInputsAsync(string, string?, IReadOnlyList<InteractionInput>, InputsDialogInteractionOptions?, CancellationToken) abstract Task<InteractionResult<InteractionInputCollection>>
Prompts the user for multiple inputs. 
public interface IInteractionService
{
    public abstract Task<InteractionResult<InteractionInputCollection>> PromptInputsAsync(
        string title,
        string? message,
        IReadOnlyList<InteractionInput> inputs,
        InputsDialogInteractionOptions? options = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}
Parameters
title string The title of the input dialog.
message string? The message to display in the dialog.
inputs IReadOnlyList<InteractionInput> A collection of InteractionInput to prompt for.
options InputsDialogInteractionOptions? optional Optional configuration for the input dialog interaction.
cancellationToken CancellationToken optional A token to cancel the operation.
Returns
Task<InteractionResult<InteractionInputCollection>> An Hosting.InteractionResult`1 containing the user's inputs as an InteractionInputCollection.
PromptMessageBoxAsync(string, string, MessageBoxInteractionOptions?, CancellationToken) Section titled PromptMessageBoxAsync(string, string, MessageBoxInteractionOptions?, CancellationToken) abstract Task<InteractionResult<bool>>
Prompts the user with a message box dialog. 
public interface IInteractionService
{
    public abstract Task<InteractionResult<bool>> PromptMessageBoxAsync(
        string title,
        string message,
        MessageBoxInteractionOptions? options = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}
Parameters
title string The title of the message box.
message string The message to display in the message box.
options MessageBoxInteractionOptions? optional Optional configuration for the message box interaction.
cancellationToken CancellationToken optional A token to cancel the operation.
Returns
Task<InteractionResult<bool>> An Hosting.InteractionResult`1 containing true if the user accepted, false otherwise.
PromptNotificationAsync(string, string, NotificationInteractionOptions?, CancellationToken) Section titled PromptNotificationAsync(string, string, NotificationInteractionOptions?, CancellationToken) abstract Task<InteractionResult<bool>>
Prompts the user with a notification. 
public interface IInteractionService
{
    public abstract Task<InteractionResult<bool>> PromptNotificationAsync(
        string title,
        string message,
        NotificationInteractionOptions? options = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}
Parameters
title string The title of the notification.
message string The message to display in the notification.
options NotificationInteractionOptions? optional Optional configuration for the notification interaction.
cancellationToken CancellationToken optional A token to cancel the operation.
Returns
Task<InteractionResult<bool>> An Hosting.InteractionResult`1 containing true if the user accepted, false otherwise.
Connect with us

Community

SHA — 037d613 © Microsoft