AdaptiveDialog Class

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Dialogs.Adaptive

Assembly:: Microsoft.Bot.Builder.Dialogs.Adaptive.dll

Package:: Microsoft.Bot.Builder.Dialogs.Adaptive v4.22.7

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The Adaptive Dialog models conversation using events and events to adapt dynamicaly to changing conversation flow.

public class AdaptiveDialog : Microsoft.Bot.Builder.Dialogs.DialogContainer, Microsoft.Bot.Builder.Dialogs.IDialogDependencies

type AdaptiveDialog = class
    inherit DialogContainer
    interface IDialogDependencies

Public Class AdaptiveDialog
Inherits DialogContainer
Implements IDialogDependencies

Inheritance: Object

Dialog

DialogContainer
AdaptiveDialog

Implements: IDialogDependencies

Constructors

AdaptiveDialog(String, String, Int32)

Initializes a new instance of the AdaptiveDialog class.

Fields

Kind	Class identifier.

Properties

AutoEndDialog	Gets or sets an expression indicating whether to end the dialog when there are no actions to execute.
DefaultResultProperty	Gets or sets the property to return as the result when the dialog ends when there are no more Actions and AutoEndDialog = true.
Dialogs	Gets or sets the containers DialogSet. (Inherited from DialogContainer)
Generator	Gets or sets language Generator override.
Id	Gets or sets id for the dialog. (Inherited from Dialog)
IgnoreMemoryScopeBinding	Gets or sets a value indicating whether or not this DialogContainer should interact with Memory Scopes. (Inherited from DialogContainer)
Recognizer	Gets or sets recognizer for processing incoming user input.
Schema	Gets or sets schema that describes what the dialog works over.
Selector	Gets or sets the selector for picking the possible events to execute.
Source	Gets the information of the cref="SourceRange"/>. (Inherited from Dialog)
TelemetryClient	Gets or sets the IBotTelemetryClient to use for logging. When setting this property, all of the contained dialogs' TelemetryClient properties are also set. (Inherited from DialogContainer)
Triggers	Gets or sets trigger handlers to respond to conditions which modifying the executing plan.

Methods

BeginDialogAsync(DialogContext, Object, CancellationToken)	Called when the dialog is started and pushed onto the dialog stack.
CheckForVersionChangeAsync(DialogContext, CancellationToken)	CheckForVersionChangeAsync. (Inherited from DialogContainer)
ContinueActionsAsync(DialogContext, Object, CancellationToken)	Waits for pending actions to complete and moves on to OnEndOfActions.
ContinueDialogAsync(DialogContext, CancellationToken)	Called when the dialog is continued, where it is the active dialog and the user replies with a new activity.
CreateChildContext(DialogContext)	Creates a child DialogContext for the given context.
EndCurrentActionAsync(ActionContext, CancellationToken)	Removes the current most action from the given ActionContext if there are any.
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	Called when the dialog is ending.
EnsureDependenciesInstalled()	Ensures all dependencies for the class are installed.
FindDialog(String, DialogContext)	Finds a child dialog that was previously added to the container. Uses DialogContext as fallback to gather the dialog from the ResourceExplorer.
FindDialog(String)	Finds a child dialog that was previously added to the container. (Inherited from DialogContainer)
GetDependencies()	Gets Dialog enumerated dependencies.
GetInternalVersion()	Gets the internal version string.
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 DialogContainer)
OnEndOfActionsAsync(ActionContext, CancellationToken)	Awaits for completed actions to finish processing entity assignments and finishes turn.
OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	Called after an event was bubbled to all parents and wasn't handled.
OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	Called before an event is bubbled to its parent.
OnRecognizeAsync(ActionContext, Activity, CancellationToken)	Recognizes intent for current activity given the class recognizer set, if set is null no intent will be recognized.
OnSetScopedServices(DialogContext)	OnSetScopedServices provides ability to set scoped services for the current dialogContext.
ProcessEventAsync(ActionContext, DialogEvent, Boolean, CancellationToken)	Event processing implementation.
RegisterSourceLocation(String, Int32)	Registers a cref="SourceRange"/> in the provided location. (Inherited from Dialog)
RepromptDialogAsync(DialogContext, DialogInstance, CancellationToken)	RepromptDialog with dialogContext.
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 completed 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

Jaa