IInteractionService

Interface

📦 Aspire.Hosting v13.5.0

interface IInteractionService {
  createBooleanInput(
      name: string,
      options?: CreateInteractionInputOptions): InteractionInputBuilder;
  createChoiceInput(
      name: string,
      choices?: InteractionChoiceOption[],
      options?: CreateInteractionInputOptions): InteractionInputBuilder;
  createFileInput(
      name: string,
      options?: CreateInteractionInputOptions): InteractionInputBuilder;
  createNumberInput(
      name: string,
      options?: CreateInteractionInputOptions): InteractionInputBuilder;
  createSecretInput(
      name: string,
      options?: CreateInteractionInputOptions): InteractionInputBuilder;
  createTextInput(
      name: string,
      options?: CreateInteractionInputOptions): InteractionInputBuilder;
  isAvailable(): boolean;
  promptConfirmation(
      title: string,
      message: string,
      options?: InteractionMessageBoxOptions,
      cancellationToken?: cancellationToken): BoolInteractionResult;
  promptInput(
      title: string,
      message: string,
      input: InteractionInputBuilder,
      options?: InteractionInputsDialogOptions,
      cancellationToken?: cancellationToken): InputInteractionResult;
  promptInputs(
      title: string,
      message: string,
      inputs: InteractionInputBuilder[],
      options?: InteractionInputsDialogOptions,
      cancellationToken?: cancellationToken): InputsInteractionResult;
  promptMessageBox(
      title: string,
      message: string,
      options?: InteractionMessageBoxOptions,
      cancellationToken?: cancellationToken): BoolInteractionResult;
  promptNotification(
      title: string,
      message: string,
      options?: InteractionNotificationOptions,
      cancellationToken?: cancellationToken): BoolInteractionResult;
  promptProgress(
      message: string,
      options?: InteractionProgressOptions,
      cancellationToken?: cancellationToken): BoolInteractionResult;
}

13 members

Methods

methodcreateBooleanInput

Creates a boolean (checkbox) input.

createBooleanInput(
    name: string,
    options?: CreateInteractionInputOptions): InteractionInputBuilder

Parameters

namestring

optionsCreateInteractionInputOptionsoptional

Returns

InteractionInputBuilder

methodcreateChoiceInput

Creates a choice input that selects from a list of options.

createChoiceInput(
    name: string,
    choices?: InteractionChoiceOption[],
    options?: CreateInteractionInputOptions): InteractionInputBuilder

Parameters

namestring

choicesInteractionChoiceOption[]optional

optionsCreateInteractionInputOptionsoptional

Returns

InteractionInputBuilder

methodcreateFileInput

Creates a file input.

createFileInput(
    name: string,
    options?: CreateInteractionInputOptions): InteractionInputBuilder

Parameters

namestring

optionsCreateInteractionInputOptionsoptional

Returns

InteractionInputBuilder

methodcreateNumberInput

Creates a numeric input.

createNumberInput(
    name: string,
    options?: CreateInteractionInputOptions): InteractionInputBuilder

Parameters

namestring

optionsCreateInteractionInputOptionsoptional

Returns

InteractionInputBuilder

methodcreateSecretInput

Creates a secret (masked) text input.

createSecretInput(
    name: string,
    options?: CreateInteractionInputOptions): InteractionInputBuilder

Parameters

namestring

optionsCreateInteractionInputOptionsoptional

Returns

InteractionInputBuilder

methodcreateTextInput

Creates a single-line text input.

createTextInput(
    name: string,
    options?: CreateInteractionInputOptions): InteractionInputBuilder

Parameters

namestring

optionsCreateInteractionInputOptionsoptional

Returns

InteractionInputBuilder

methodisAvailable

Gets a value indicating whether the interaction service is available to prompt the user.

isAvailable(): boolean

Returns

boolean

methodpromptConfirmation

Prompts the user for confirmation with an OK/Cancel dialog.

promptConfirmation(
    title: string,
    message: string,
    options?: InteractionMessageBoxOptions,
    cancellationToken?: cancellationToken): BoolInteractionResult

Parameters

titlestring

messagestring

optionsInteractionMessageBoxOptionsoptional

cancellationTokencancellationTokenoptional

Returns

BoolInteractionResult

methodpromptInput

Prompts the user for a single input.

promptInput(
    title: string,
    message: string,
    input: InteractionInputBuilder,
    options?: InteractionInputsDialogOptions,
    cancellationToken?: cancellationToken): InputInteractionResult

Parameters

titlestring

messagestring

inputInteractionInputBuilder

optionsInteractionInputsDialogOptionsoptional

cancellationTokencancellationTokenoptional

Returns

InputInteractionResult

methodpromptInputs

Prompts the user for multiple inputs.

promptInputs(
    title: string,
    message: string,
    inputs: InteractionInputBuilder[],
    options?: InteractionInputsDialogOptions,
    cancellationToken?: cancellationToken): InputsInteractionResult

Parameters

titlestring

messagestring

inputsInteractionInputBuilder[]

optionsInteractionInputsDialogOptionsoptional

cancellationTokencancellationTokenoptional

Returns

InputsInteractionResult

methodpromptMessageBox

Prompts the user with a message box dialog.

promptMessageBox(
    title: string,
    message: string,
    options?: InteractionMessageBoxOptions,
    cancellationToken?: cancellationToken): BoolInteractionResult

Parameters

titlestring

messagestring

optionsInteractionMessageBoxOptionsoptional

cancellationTokencancellationTokenoptional

Returns

BoolInteractionResult

methodpromptNotification

Prompts the user with a notification.

promptNotification(
    title: string,
    message: string,
    options?: InteractionNotificationOptions,
    cancellationToken?: cancellationToken): BoolInteractionResult

Parameters

titlestring

messagestring

optionsInteractionNotificationOptionsoptional

cancellationTokencancellationTokenoptional

Returns

BoolInteractionResult

methodpromptProgress

Displays a progress dialog with an indeterminate progress indicator.

promptProgress(
    message: string,
    options?: InteractionProgressOptions,
    cancellationToken?: cancellationToken): BoolInteractionResult

Parameters

messagestring

optionsInteractionProgressOptionsoptional

cancellationTokencancellationTokenoptional

Returns

BoolInteractionResult