IInteractionService Methods

InterfaceMethods6 members

A service to interact with the current development environment.

PromptConfirmationAsync(string, string, MessageBoxInteractionOptions?, CancellationToken)abstractTask<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

titlestringThe title of the dialog.

messagestringThe message to display in the dialog.

optionsMessageBoxInteractionOptions?optionalOptional configuration for the message box interaction.

cancellationTokenCancellationTokenoptionalA 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)abstractTask<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

titlestringThe title of the input dialog.

messagestring?The message to display in the dialog.

inputLabelstringThe label for the input field.

placeHolderstringThe placeholder text for the input field.

optionsInputsDialogInteractionOptions?optionalOptional configuration for the input dialog interaction.

cancellationTokenCancellationTokenoptionalA token to cancel the operation.

Returns

Task<InteractionResult<InteractionInput>> An Hosting.InteractionResult`1 containing the user's input.

PromptInputAsync(string, string?, InteractionInput, InputsDialogInteractionOptions?, CancellationToken)abstractTask<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

titlestringThe title of the input dialog.

messagestring?The message to display in the dialog.

inputInteractionInputThe input configuration.

optionsInputsDialogInteractionOptions?optionalOptional configuration for the input dialog interaction.

cancellationTokenCancellationTokenoptionalA 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)abstractTask<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

titlestringThe title of the input dialog.

messagestring?The message to display in the dialog.

inputsIReadOnlyList<InteractionInput>A collection of InteractionInput to prompt for.

optionsInputsDialogInteractionOptions?optionalOptional configuration for the input dialog interaction.

cancellationTokenCancellationTokenoptionalA 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)abstractTask<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

titlestringThe title of the message box.

messagestringThe message to display in the message box.

optionsMessageBoxInteractionOptions?optionalOptional configuration for the message box interaction.

cancellationTokenCancellationTokenoptionalA 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)abstractTask<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

titlestringThe title of the notification.

messagestringThe message to display in the notification.

optionsNotificationInteractionOptions?optionalOptional configuration for the notification interaction.

cancellationTokenCancellationTokenoptionalA token to cancel the operation.

Returns

Task<InteractionResult<bool>> An Hosting.InteractionResult`1 containing true if the user accepted, false otherwise.