BeginDialog Class

Reference

Definition

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

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.

Action which begins executing another dialog, when it is done, it will return to the caller.

public class BeginDialog : Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.BaseInvokeDialog

type BeginDialog = class
    inherit BaseInvokeDialog

Public Class BeginDialog
Inherits BaseInvokeDialog

Inheritance: Object

Dialog

BaseInvokeDialog
BeginDialog

Derived: Microsoft.Bot.Builder.Dialogs.Adaptive.Actions.DynamicBeginDialog

Constructors

BeginDialog(String, Object, String, Int32)

Initializes a new instance of the BeginDialog class.

Fields

Kind	Class identifier.

Properties

ActivityProcessed	Gets or sets a value indicating whether to have the new dialog should process the activity. (Inherited from BaseInvokeDialog)
Dialog	Gets or sets the dialog to call. (Inherited from BaseInvokeDialog)
Disabled	Gets or sets an optional expression which if is true will disable this action.
Id	Gets or sets id for the dialog. (Inherited from Dialog)
Options	Gets or sets configurable options for the dialog. (Inherited from BaseInvokeDialog)
ResultProperty	Gets or sets the property path to store the dialog result in.
Source	Gets the information of the cref="SourceRange"/>. (Inherited from Dialog)
TelemetryClient	Gets or sets the IBotTelemetryClient to use for logging. (Inherited from Dialog)

Methods

BeginDialogAsync(DialogContext, Object, CancellationToken)	Called when the dialog is started and pushed onto the dialog stack.
BindOptions(DialogContext, Object)	BindOptions - evaluate expressions in options. (Inherited from BaseInvokeDialog)
ContinueDialogAsync(DialogContext, CancellationToken)	Called when the dialog is continued, where it is the active dialog and the user replies with a new activity. (Inherited from Dialog)
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	Called when the dialog is ending. (Inherited from Dialog)
GetDependencies()	Enumerates child dialog dependencies so they can be added to the containers dialog set. (Inherited from BaseInvokeDialog)
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 BaseInvokeDialog)
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)
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. (Inherited from Dialog)
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)
ResolveDialog(DialogContext)	Resolve Dialog Expression as either Dialog, or StringExpression to get dialogid. (Inherited from BaseInvokeDialog)
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