ComponentDialog Class

Definition

A Dialog that is composed of other dialogs.

public class ComponentDialog : Microsoft.Bot.Builder.Dialogs.DialogContainer
type ComponentDialog = class
    inherit DialogContainer
Public Class ComponentDialog
Inherits DialogContainer
Inheritance
ComponentDialog

Remarks

A component dialog has an inner DialogSet and DialogContext, which provides an inner dialog stack that is hidden from the parent dialog.

Constructors

ComponentDialog(String)

Initializes a new instance of the ComponentDialog class.

Fields

PersistedDialogState

The id for the persisted dialog state.

Properties

Dialogs

Gets or sets the containers DialogSet.

(Inherited from DialogContainer)
Id

Gets or sets id for the dialog.

(Inherited from Dialog)
InitialDialogId

Gets or sets the id assigned to the initial dialog.

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)

Methods

AddDialog(Dialog)

Adds a new Dialog to the component dialog and returns the updated component.

BeginDialogAsync(DialogContext, Object, CancellationToken)

Called when the dialog is started and pushed onto the parent's dialog stack.

CheckForVersionChangeAsync(DialogContext, CancellationToken)

CheckForVersionChangeAsync.

(Inherited from DialogContainer)
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 an inner DialogContext.

EndComponentAsync(DialogContext, Object, CancellationToken)

Ends the component dialog in its parent's context.

EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)

Called when the dialog is ending.

EnsureInitializedAsync(DialogContext)

Ensures the dialog is initialized.

FindDialog(String)

Finds a child dialog that was previously added to the container.

(Inherited from DialogContainer)
GetInternalVersion()

GetInternalVersion - Returns internal version identifier for this container.

(Inherited from DialogContainer)
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)
OnBeginDialogAsync(DialogContext, Object, CancellationToken)

Called when the dialog is started and pushed onto the parent's dialog stack.

OnComputeId()

Computes an unique ID for a dialog.

(Inherited from Dialog)
OnContinueDialogAsync(DialogContext, CancellationToken)

Called when the dialog is continued, where it is the active dialog and the user replies with a new activity.

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)
OnEndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)

Called when the dialog is ending.

OnInitializeAsync(DialogContext)

Initilizes the 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)
OnRepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)

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

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.

ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)

Called when a child dialog on the parent's dialog stack completed this turn, returning control to this dialog component.

Extension Methods

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

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

Applies to