Class ComponentDialog<O>

Base class for a dialog that contains other child dialogs.

Remarks

Component dialogs let you break your agent's logic up into components that can themselves be added as a dialog to another ComponentDialog or DialogSet. Components can also be exported as part of a node package and used within other agents.

Type Parameters

O extends object = {}
(Optional) options that can be passed into the DialogContext.beginDialog() method.

Hierarchy (View Summary)

DialogContainer<O>
- ComponentDialog

Constructors

constructor

new ComponentDialog<O extends object = {}>(
dialogId?: string,
): ComponentDialog<O>
Creates a new instance of the Dialog class.
Type Parameters
- O extends object = {}
  (Optional) options that can be passed into the DialogContext.beginDialog() method.
Parameters
- OptionaldialogId: string
  Optional. unique ID of the dialog.
Returns ComponentDialog<O>
Inherited from DialogContainer.constructor
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:36

Properties

`Readonly`dialogs

dialogs: DialogSet = ...

The containers dialog set.

`Protected`initialDialogId

initialDialogId: string

ID of the child dialog that should be started anytime the component is started.

Remarks

This defaults to the ID of the first child dialog added using addDialog().

`Static`EndOfTurn

EndOfTurn: DialogTurnResult = ...

Gets a default end-of-turn result.

Remarks

This result indicates that a dialog (or a logical step within a dialog) has completed processing for the current turn, is still active, and is waiting for more input.

Accessors

id

get id(): string
Unique ID of the dialog.

Returns string
The Id for the dialog.

Remarks
This will be automatically generated if not specified.
Inherited from DialogContainer.id
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:49
set id(value: string): void
Sets the unique ID of the dialog.
Parameters
- value: string
Returns void
Inherited from DialogContainer.id
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:59

Methods

addDialog

addDialog(dialog: Dialog): this
Adds a child Dialog or prompt to the components internal DialogSet.
Parameters
- dialog: Dialog
  The child Dialog or prompt to add.
Returns this
The ComponentDialog after the operation is complete.

Remarks
The Dialog.id of the first child added to the component will be assigned to the initialDialogId property.
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:189

beginDialog

beginDialog(
outerDialogContext: DialogContext,
options?: O,
): Promise<DialogTurnResult<any>>
Called when the dialog is started and pushed onto the parent's dialog stack.
Parameters
- outerDialogContext: DialogContext
  The parent DialogContext for the current turn of conversation.
- Optionaloptions: O
  Optional, initial information to pass to the dialog.
Returns Promise<DialogTurnResult<any>>
A Promise representing the asynchronous operation.

Remarks
If the task is successful, the result indicates whether the dialog is still active after the turn has been processed by the dialog. By default, this calls the Dialog.BeginDialogAsync(DialogContext, object, CancellationToken) method of the component dialog's initial dialog, as defined by InitialDialogId. Override this method in a derived class to implement interrupt logic.
Overrides DialogContainer.beginDialog
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:52

`Protected`checkForVersionChange

checkForVersionChange(dialogContext: DialogContext): Promise<void>
Checks to see if a containers child dialogs have changed since the current dialog instance was started.
Parameters
- dialogContext: DialogContext
  Current dialog context.
Returns Promise<void>
Remarks
This should be called at the start of beginDialog(), continueDialog(), and resumeDialog().
Inherited from DialogContainer.checkForVersionChange
- Defined in packages/agents-hosting-dialogs/src/dialogContainer.ts:81

configure

configure(config: Record<string, unknown>): this
Fluent method for configuring the object.
Parameters
- config: Record<string, unknown>
  Configuration settings to apply.
Returns this
The Configurable after the operation is complete.
Inherited from DialogContainer.configure
- Defined in packages/agents-hosting-dialogs/src/configurable.ts:18

continueDialog

continueDialog(
outerDialogContext: DialogContext,
): Promise<DialogTurnResult<any>>
Called when the dialog is continued, where it is the active dialog and the user replies with a new Activity.
Parameters
- outerDialogContext: DialogContext
  The parent DialogContext for the current turn of conversation.
Returns Promise<DialogTurnResult<any>>
A Promise representing the asynchronous operation.

Remarks
If this method is not overridden, the dialog automatically ends when the user replies. If the task is successful, the result indicates whether the dialog is still active after the turn has been processed by the dialog. The result may also contain a return value.
Overrides DialogContainer.continueDialog
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:90

createChildContext

createChildContext(outerDialogContext: DialogContext): DialogContext
Creates the inner dialog context
Parameters
- outerDialogContext: DialogContext
  the outer dialog context
Returns DialogContext
The created Dialog Context.
Overrides DialogContainer.createChildContext
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:204

`Protected`endComponent

endComponent(
outerDC: DialogContext,
result: any,
): Promise<DialogTurnResult<any>>
Called when the components last active child dialog ends and the component is ending.
Parameters
- outerDC: DialogContext
  Dialog context for the parents DialogSet.
- result: any
  Result returned by the last active child dialog. Can be a value of undefined.
Returns Promise<DialogTurnResult<any>>
A promise resolving to the dialog turn result.

Remarks
SHOULD be overridden by components that wish to perform custom logic before the component ends. The default implementation calls outerDC.endDialog() with the result returned from the last active child dialog.
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:283

endDialog

endDialog(
    context: TurnContext,
    instance: DialogInstance,
    reason: DialogReason,
): Promise<void>
Called when the Dialog is ending.
Parameters
- context: TurnContext
  The TurnContext object for this turn.
- instance: DialogInstance
  State information associated with the instance of this component Dialog on its parent's dialog stack.
- reason: DialogReason
  Reason why the Dialog ended.
Returns Promise<void>
A Promise representing the asynchronous operation.

Remarks
When this method is called from the parent dialog's context, the component Dialog cancels all of the dialogs on its inner dialog stack before ending.
Overrides DialogContainer.endDialog
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:169

findDialog

findDialog(dialogId: string): Dialog<{}>
Finds a child dialog that was previously added to the container.
Parameters
- dialogId: string
  ID of the dialog to lookup.
Returns Dialog<{}>
The Dialog if found; otherwise null.
Inherited from DialogContainer.findDialog
- Defined in packages/agents-hosting-dialogs/src/dialogContainer.ts:34

getConverter

getConverter(_property: string): Converter<unknown, unknown> | ConverterFactory
Gets the converter for the selector configuration. *
Parameters
- _property: string
  The key of the conditional selector configuration. *
Returns Converter<unknown, unknown> | ConverterFactory
The converter for the selector configuration.
Inherited from DialogContainer.getConverter
- Defined in packages/agents-hosting-dialogs/src/configurable.ts:53

`Protected`getInternalVersion

getInternalVersion(): string
Returns internal version identifier for this container.

Returns string
Version which represents the change of the internals of this container.

Remarks
DialogContainers detect changes of all sub-components in the container and map that to a versionChanged event. Because they do this, DialogContainers "hide" the internal changes and just have the .id. This isolates changes to the container level unless a container doesn't handle it. To support this DialogContainers define a protected method getInternalVersion() which computes if this dialog or child dialogs have changed which is then examined via calls to checkForVersionChange().
Inherited from DialogContainer.getInternalVersion
- Defined in packages/agents-hosting-dialogs/src/dialogContainer.ts:67

getVersion

getVersion(): string
An encoded string used to aid in the detection of agent changes on re-deployment.

Returns string
Unique string which should only change when dialog has changed in a way that should restart the dialog.

Remarks
This defaults to returning the dialog's id but can be overridden to provide more precise change detection logic. Any dialog on the stack that has its version change will result in a versionChanged event will be raised. If this event is not handled by the agent, an error will be thrown resulting in the agent error handler logic being run.

Returning an empty string will disable version tracking for the component all together.
Inherited from DialogContainer.getVersion
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:77

`Protected`onBeginDialog

onBeginDialog(
innerDialogContext: DialogContext,
options?: O,
): Promise<DialogTurnResult<any>>
Called anytime an instance of the component has been started.
Parameters
- innerDialogContext: DialogContext
  Dialog context for the components internal DialogSet.
- Optionaloptions: O
  (Optional) options that were passed to the component by its parent.
Returns Promise<DialogTurnResult<any>>
A promise resolving to the dialog turn result.

Remarks
SHOULD be overridden by components that wish to perform custom interruption logic. The default implementation calls innerDC.beginDialog() with the dialog assigned to initialDialogId.
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:221

`Protected`onComputeId

onComputeId(): string
Called when a unique ID needs to be computed for a dialog.

Returns string
Remarks
SHOULD be overridden to provide a more contextually relevant ID. The preferred pattern for ID's is <dialog type>(this.hashedLabel('<dialog args>')).
Inherited from DialogContainer.onComputeId
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:248

`Protected`onContinueDialog

onContinueDialog(innerDC: DialogContext): Promise<DialogTurnResult<any>>
Called anytime a multi-turn component receives additional activities.
Parameters
- innerDC: DialogContext
  Dialog context for the components internal DialogSet.
Returns Promise<DialogTurnResult<any>>
A promise resolving to the dialog turn result.

Remarks
SHOULD be overridden by components that wish to perform custom interruption logic. The default implementation calls innerDC.continueDialog().
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:235

onDialogEvent

onDialogEvent(
dialogContext: DialogContext,
event: DialogEvent,
): Promise<boolean>
Called when an event has been raised, using DialogContext.emitEvent(), by either the current dialog or a dialog that the current dialog started.
Parameters
- dialogContext: DialogContext
  The dialog context for the current turn of conversation.
- event: DialogEvent
  The event being raised.
Returns Promise<boolean>
True if the event is handled by the current dialog and bubbling should stop.
Inherited from DialogContainer.onDialogEvent
- Defined in packages/agents-hosting-dialogs/src/dialogContainer.ts:46

`Protected`onEndDialog

onEndDialog(
    _context: TurnContext,
    _instance: DialogInstance,
    _reason: DialogReason,
): Promise<void>
Called when the component is ending.
Parameters
- _context: TurnContext
  Context for the current turn of conversation.
- _instance: DialogInstance
  The components instance data within its parents dialog stack.
- _reason: DialogReason
  The reason the component is ending.
Returns Promise<void>
A promise representing the asynchronous operation.

Remarks
If the reason code is equal to DialogReason.cancelCalled, then any active child dialogs will be cancelled before this method is called.
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:252

`Protected`onPostBubbleEvent

onPostBubbleEvent(_dc: DialogContext, _e: DialogEvent): Promise<boolean>
Called after an event was bubbled to all parents and wasn't handled.
Parameters
- _dc: DialogContext
  The dialog context for the current turn of conversation.
- _e: DialogEvent
  The event being raised.
Returns Promise<boolean>
Whether the event is handled by the current dialog and further processing should stop.

Remarks
This is a good place to perform default processing logic for an event. Returning true will prevent any processing of the event by child dialogs.
Inherited from DialogContainer.onPostBubbleEvent
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:237

`Protected`onPreBubbleEvent

onPreBubbleEvent(_dc: DialogContext, _e: DialogEvent): Promise<boolean>
Called before an event is bubbled to its parent.
Parameters
- _dc: DialogContext
  The dialog context for the current turn of conversation.
- _e: DialogEvent
  The event being raised.
Returns Promise<boolean>
Whether the event is handled by the current dialog and further processing should stop.

Remarks
This is a good place to perform interception of an event as returning true will prevent any further bubbling of the event to the dialogs parents and will also prevent any child dialogs from performing their default processing.
Inherited from DialogContainer.onPreBubbleEvent
- Defined in packages/agents-hosting-dialogs/src/dialog.ts:222

`Protected`onRepromptDialog

onRepromptDialog(
_context: TurnContext,
_instance: DialogInstance,
): Promise<void>
Called when the component has been requested to re-prompt the user for input.
Parameters
- _context: TurnContext
  Context for the current turn of conversation.
- _instance: DialogInstance
  The instance of the current dialog.
Returns Promise<void>
A promise representing the asynchronous operation.

Remarks
The active child dialog will have already been asked to reprompt before this method is called.
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:267

repromptDialog

repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>
Called when the dialog should re-prompt the user for input.
Parameters
- context: TurnContext
  The TurnContext object for this turn.
- instance: DialogInstance
  State information for this dialog.
Returns Promise<void>
A Promise representing the asynchronous operation.
Overrides DialogContainer.repromptDialog
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:147

resumeDialog

resumeDialog(
    outerDialogContext: DialogContext,
    _reason: DialogReason,
    _result?: any,
): Promise<DialogTurnResult<any>>
Called when a child dialog on the parent's dialog stack completed this turn, returning control to this dialog component.
Parameters
- outerDialogContext: DialogContext
  The DialogContext for the current turn of conversation.
- _reason: DialogReason
  Reason why the dialog resumed.
- Optional_result: any
  Optional, value returned from the dialog that was called. The type of the value returned is dependent on the child dialog.
Returns Promise<DialogTurnResult<any>>
A Promise representing the asynchronous operation.

Remarks
If the task is successful, the result indicates whether this dialog is still active after this dialog turn has been processed. Generally, the child dialog was started with a call to beginDialog(DialogContext, object) in the parent's context. However, if the DialogContext.replaceDialog(string, object) method is called, the logical child dialog may be different than the original. If this method is not overridden, the dialog automatically calls its RepromptDialog(ITurnContext, DialogInstance) when the user replies.
Overrides DialogContainer.resumeDialog
- Defined in packages/agents-hosting-dialogs/src/componentDialog.ts:127

Class ComponentDialog<O>

Remarks

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ComponentDialog<O>

Properties

Readonlydialogs

ProtectedinitialDialogId

Remarks

StaticEndOfTurn

Remarks

Accessors

id

Returns string

Remarks

Parameters

Returns void

Methods

addDialog

Parameters

Returns this

Remarks

beginDialog

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

ProtectedcheckForVersionChange

Parameters

Returns Promise<void>

Remarks

configure

Parameters

Returns this

continueDialog

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

createChildContext

Parameters

Returns DialogContext

ProtectedendComponent

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

endDialog

Parameters

Returns Promise<void>

Remarks

findDialog

Parameters

Returns Dialog<{}>

getConverter

Parameters

Returns Converter<unknown, unknown> | ConverterFactory

ProtectedgetInternalVersion

Returns string

Remarks

getVersion

Returns string

Remarks

ProtectedonBeginDialog

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

ProtectedonComputeId

Returns string

Remarks

ProtectedonContinueDialog

Parameters

Returns Promise<DialogTurnResult<any>>

Remarks

`Readonly`dialogs

`Protected`initialDialogId

`Static`EndOfTurn

`Protected`checkForVersionChange

`Protected`endComponent

`Protected`getInternalVersion

`Protected`onBeginDialog

`Protected`onComputeId

`Protected`onContinueDialog

`Protected`onEndDialog

`Protected`onPostBubbleEvent

`Protected`onPreBubbleEvent

`Protected`onRepromptDialog