InteractionService
A service to interact with the current development environment.
type InteractionService interface{}Methods
CreateBooleanInput CreateBooleanInput( name string, options ...*CreateInteractionInputOptions,) InteractionInputBuilderParameters
namestringoptions...*CreateInteractionInputOptions Optional settings, described under Options.Options
Optional parameters are passed as the existing *CreateInteractionInputOptions struct.
Returns
InteractionInputBuilder Returns a handle; failures surface later via Err().
CreateChoiceInput CreateChoiceInput( name string, options ...*CreateChoiceInputOptions,) InteractionInputBuilderParameters
namestringThe name of the input.options...*CreateChoiceInputOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*CreateChoiceInputOptions argument.
Choices[]*InteractionChoiceOption The available choices, in display order. Each option pairs a submitted value with a display label.Options*CreateInteractionInputOptions Optional configuration for the input.Returns
InteractionInputBuilder Returns a handle; failures surface later via Err().
CreateFileInput CreateFileInput( name string, options ...*CreateInteractionInputOptions,) InteractionInputBuilderParameters
namestringoptions...*CreateInteractionInputOptions Optional settings, described under Options.Options
Optional parameters are passed as the existing *CreateInteractionInputOptions struct.
Returns
InteractionInputBuilder Returns a handle; failures surface later via Err().
CreateNumberInput CreateNumberInput( name string, options ...*CreateInteractionInputOptions,) InteractionInputBuilderParameters
namestringoptions...*CreateInteractionInputOptions Optional settings, described under Options.Options
Optional parameters are passed as the existing *CreateInteractionInputOptions struct.
Returns
InteractionInputBuilder Returns a handle; failures surface later via Err().
CreateSecretInput CreateSecretInput( name string, options ...*CreateInteractionInputOptions,) InteractionInputBuilderParameters
namestringoptions...*CreateInteractionInputOptions Optional settings, described under Options.Options
Optional parameters are passed as the existing *CreateInteractionInputOptions struct.
Returns
InteractionInputBuilder Returns a handle; failures surface later via Err().
CreateTextInput CreateTextInput( name string, options ...*CreateInteractionInputOptions,) InteractionInputBuilderParameters
namestringoptions...*CreateInteractionInputOptions Optional settings, described under Options.Options
Optional parameters are passed as the existing *CreateInteractionInputOptions struct.
Returns
InteractionInputBuilder Returns a handle; failures surface later via Err().
IsAvailable IsAvailable() (bool, error)Returns
(bool, error) true when the service can prompt the user; otherwise false.
Returns (bool, error).
PromptConfirmation PromptConfirmation( title string, message string, options ...*PromptConfirmationOptions,) (*BoolInteractionResult, error)Parameters
titlestringmessagestringoptions...*PromptConfirmationOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*PromptConfirmationOptions argument.
Options*InteractionMessageBoxOptions CancellationToken *CancellationToken Returns
(*BoolInteractionResult, error) Returns (*BoolInteractionResult, error).
PromptInput PromptInput( title string, message string, input InteractionInputBuilder, options ...*PromptInputOptions,) (*InputInteractionResult, error)Parameters
titlestringmessagestringinputInteractionInputBuilder options...*PromptInputOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*PromptInputOptions argument.
Options*InteractionInputsDialogOptions CancellationToken *CancellationToken Returns
(*InputInteractionResult, error) Returns (*InputInteractionResult, error).
PromptInputs PromptInputs( title string, message string, inputs []InteractionInputBuilder, options ...*PromptInputsOptions,) InputsInteractionResultParameters
titlestringmessagestringinputs[]InteractionInputBuilder options...*PromptInputsOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*PromptInputsOptions argument.
Options*InteractionInputsDialogOptions CancellationToken *CancellationToken Returns
InputsInteractionResult Returns a handle; failures surface later via Err().
PromptMessageBox PromptMessageBox( title string, message string, options ...*PromptMessageBoxOptions,) (*BoolInteractionResult, error)Parameters
titlestringmessagestringoptions...*PromptMessageBoxOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*PromptMessageBoxOptions argument.
Options*InteractionMessageBoxOptions CancellationToken *CancellationToken Returns
(*BoolInteractionResult, error) Returns (*BoolInteractionResult, error).
PromptNotification PromptNotification( title string, message string, options ...*PromptNotificationOptions,) (*BoolInteractionResult, error)Parameters
titlestringmessagestringoptions...*PromptNotificationOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*PromptNotificationOptions argument.
Options*InteractionNotificationOptions CancellationToken *CancellationToken Returns
(*BoolInteractionResult, error) Returns (*BoolInteractionResult, error).
PromptProgress PromptProgress( message string, options ...*PromptProgressOptions,) (*BoolInteractionResult, error)Parameters
messagestringoptions...*PromptProgressOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*PromptProgressOptions argument.
Options*InteractionProgressOptions CancellationToken *CancellationToken Returns
(*BoolInteractionResult, error) Returns (*BoolInteractionResult, error).
Applies to
This interface applies to the following types: