InputDialog Class

  • Reference

Definition

Namespace:
Microsoft.Bot.Builder.Dialogs.Adaptive.Input
Assembly:
Microsoft.Bot.Builder.Dialogs.Adaptive.dll
Package:
Microsoft.Bot.Builder.Dialogs.Adaptive v4.18.1

Defines input dialogs.

public abstract class InputDialog : Microsoft.Bot.Builder.Dialogs.Dialog
type InputDialog = class
    inherit Dialog
Public MustInherit Class InputDialog
Inherits Dialog
Inheritance
Object
Dialog
InputDialog
Derived

Constructors

InputDialog()

Fields

TURN_COUNT_PROPERTY

Defines dialog context turn count property value.
VALUE_PROPERTY

Defines dialog context state property value.

Properties

AllowInterruptions

Gets or sets intteruption policy.
AlwaysPrompt

Gets or sets a value indicating whether the input should always prompt the user regardless of there being a value or not.
DefaultValue

Gets or sets the default value for the input dialog when MaxTurnCount is exceeded.
DefaultValueResponse

Gets or sets the activity template to send when MaxTurnCount has been reached and the default value is used.
Disabled

Gets or sets whether this action should be disabled.
Id

Gets or sets id for the dialog.

(Inherited from Dialog)
InvalidPrompt

Gets or sets the activity template to send to the user whenever the value provided is invalid.
MaxTurnCount

Gets or sets maximum number of times to ask the user for this value before the dialog gives up.
Prompt

Gets or sets the activity to send to the user.
Property

Gets or sets the memory property path which the value will be bound to.
Source

Gets the information of the cref="SourceRange"/>.

(Inherited from Dialog)
TelemetryClient

Gets or sets the IBotTelemetryClient to use for logging.

(Inherited from Dialog)
UnrecognizedPrompt

Gets or sets the activity template for retrying.
Validations

Gets or sets the expressions to run to validate the input.
Value

Gets or sets a the expression to use to bind input to the dialog.

Methods

AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, CancellationToken)

AppendChoices is utility method to build up a message activity given all of the options.
BeginDialogAsync(DialogContext, Object, CancellationToken)

Called when the dialog is started and pushed onto the dialog stack.
ContinueDialogAsync(DialogContext, CancellationToken)

Called when the dialog is continued, where it is the active dialog and the user replies with a new activity.
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)

Called when the dialog is ending.

(Inherited from Dialog)
GetVersion()

Gets a unique string which represents the version of this dialog. If the version changes between turns the dialog system will emit a DialogChanged event.

(Inherited from Dialog)
OnComputeId()

Builds the compute Id for the dialog.

(Inherited from Dialog)
OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken)

Called when an event has been raised, using DialogContext.emitEvent(), by either the current dialog or a dialog that the current dialog started.

(Inherited from Dialog)
OnInitializeOptions(DialogContext, Object)

Method which processes options.
OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)

Called after an event was bubbled to all parents and wasn't handled.

(Inherited from Dialog)
OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)

Called before an event is bubbled to its parent.
OnRecognizeInputAsync(DialogContext, CancellationToken)

Called when input has been received, override this method to customize recognition of the input.
OnRenderPromptAsync(DialogContext, InputState, CancellationToken)

Method which renders the prompt to the user give n the current input state.
RegisterSourceLocation(String, Int32)

Registers a cref="SourceRange"/> in the provided location.

(Inherited from Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)

Called when the dialog should re-prompt the user for input.

(Inherited from Dialog)
ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)

Called when a child dialog completes its turn, returning control to this dialog.

Extension Methods

RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken)

Creates a dialog stack and starts a dialog, pushing it onto the stack.

Applies to