SkillDialog Class

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Dialogs

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

Package:: Microsoft.Bot.Builder.Dialogs 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.

A specialized Dialog that can wrap remote calls to a skill.

public class SkillDialog : Microsoft.Bot.Builder.Dialogs.Dialog

type SkillDialog = class
    inherit Dialog

Public Class SkillDialog
Inherits Dialog

Inheritance: Object

Dialog
SkillDialog

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

Remarks

The options parameter in BeginDialogAsync(DialogContext, Object, CancellationToken) must be a BeginSkillDialogOptions instance with the initial parameters for the dialog.

Constructors

SkillDialog(SkillDialogOptions, String)

Initializes a new instance of the SkillDialog class to wrap remote calls to a skill.

Properties

DialogOptions	Gets the options used to execute the skill dialog.
Id	Gets or sets id for the dialog. (Inherited from Dialog)
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 skill dialog is started and pushed onto the dialog stack.
ContinueDialogAsync(DialogContext, CancellationToken)	Called when the skill dialog is continued, where it is the active dialog and the user replies with a new activity.
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	Called when the skill dialog is ending.
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 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)
OnValidateActivity(Activity)	Validates the activity sent during ContinueDialogAsync(DialogContext, CancellationToken).
RegisterSourceLocation(String, Int32)	Registers a cref="SourceRange"/> in the provided location. (Inherited from Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)	Called when the skill dialog should re-prompt the user for input.
ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)	Called when a child skill 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

Share via