SkillDialog class

A sample dialog that can wrap remote calls to a skill.

new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)

Parameters

Remarks

The options parameter in beginDialog() must be a SkillDialogArgs object with the initial parameters for the dialog.

Unique ID of the dialog. Sets the unique ID of the dialog.

string id

Property Value

The Id for the dialog.

Remarks

This will be automatically generated if not specified.

Gets the telemetry client for this dialog. Sets the telemetry client for this dialog.

BotTelemetryClient telemetryClient

Property Value

The BotTelemetryClient to use for logging.

Gets a default end-of-turn result.

static EndOfTurn: DialogTurnResult

Property Value

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.

Inherited From Dialog.EndOfTurn

Called when the skill dialog is started and pushed onto the dialog stack.

function beginDialog(dc: DialogContext, options: BeginSkillDialogOptions): Promise<DialogTurnResult>

Parameters

Returns

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.

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

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parameters

Returns

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. The result may also contain a return value.

Called when the skill dialog is ending.

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Parameters

Returns

A Promise representing the asynchronous operation.

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

function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>

Parameters

Returns

A Promise representing the asynchronous operation.

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

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

Parameters

Returns

A Promise representing the asynchronous operation.

Fluent method for configuring the object.

function configure(config: Record<string, unknown>): this

Parameters

Returns

The Configurable after the operation is complete.

Inherited From Configurable.configure

function getConverter(_property: string): Converter | ConverterFactory

Parameters

Returns

The converter for the selector configuration.

Inherited From Configurable.getConverter

An encoded string used to aid in the detection of bot changes on re-deployment.

function getVersion(): string

Returns

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

Remarks

This defaults to returning the dialogs 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 bot, an error will be thrown resulting in the bots error handler logic being run.

Returning an empty string will disable version tracking for the component all together.

Inherited From Dialog.getVersion

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

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parameters

Returns

True if the event is handled by the current dialog and bubbling should stop.

Inherited From Dialog.onDialogEvent