DialogContext 类

定义

命名空间:

Microsoft.Bot.Builder.Dialogs

程序集:

Microsoft.Bot.Builder.Dialogs.dll

包:

Microsoft.Bot.Builder.Dialogs v4.18.1

为对话堆栈的当前状态提供上下文。

public class DialogContext

type DialogContext = class

Public Class DialogContext

继承

Object

DialogContext

派生

Microsoft.Bot.Builder.Dialogs.Adaptive.ActionContext

Microsoft.Bot.Builder.Dialogs.WaterfallStepContext

注解

属性 Context 包含 ITurnContext 当前轮次的 。

构造函数

DialogContext(DialogSet, DialogContext, DialogState)	初始化 DialogContext 类的新实例。
DialogContext(DialogSet, ITurnContext, DialogState)	从轮次上下文初始化 类的新实例 DialogContext 。

属性

ActiveDialog	如果堆栈为空，则获取堆栈 null 顶部的活动对话的缓存实例。
Child	获取子级的对话上下文（如果有活动子级）。
Context	获取当前会话轮次的上下文。
DialogManager	已过时. 获取此 dialogContext 的当前 DialogManager。 此属性已过时。
Dialogs	获取当前对话容器处于活动状态的对话集。
Parent	获取或设置父 DialogContext级 （如果有）。 在搜索要启动的对话的 ID 时使用。
Services	获取与此对话上下文相关的服务集合。
Stack	获取当前对话框堆栈。
State	获取或设置 DialogStateManager，它管理所有内存范围的视图。

方法

BeginDialogAsync(String, Object, CancellationToken)	启动新对话并将其推送到对话堆栈上。
CancelAllDialogsAsync(Boolean, String, Object, CancellationToken)	删除任何现有对话堆栈，从而取消堆栈上的所有对话。
CancelAllDialogsAsync(CancellationToken)	删除任何现有对话堆栈，从而取消堆栈上的所有对话。
ContinueDialogAsync(CancellationToken)	通过将当前 DialogContext 传递给活动对话的 方法，继续执行活动对话 ContinueDialogAsync(DialogContext, CancellationToken) （如果有）。
EmitEventAsync(String, Object, Boolean, Boolean, CancellationToken)	搜索具有给定 ID 的对话框。 为当前对话框或启动该对话框的人员发出一个命名事件，以便处理该事件。
EndDialogAsync(Object, CancellationToken)	通过从堆栈中弹出对话框来结束对话，并将可选结果返回给对话框的父级。 父对话是通过调用 BeginDialogAsync(String, Object, CancellationToken) 或 PromptAsync(String, PromptOptions, CancellationToken)结束启动的对话。 父对话将使用返回的任何结果调用其 ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) 方法。 如果父对话尚未实现 ResumeDialogAsync 方法，则它也将自动结束，并将结果传递给其父对话。 如果堆栈上没有更多的父对话，则轮次的处理将结束。
FindDialog(String)	查找给定上下文的对话框 ID。
GetLocale()	在 DialogContext 中获取 CultureInfo。
PromptAsync(String, PromptOptions, CancellationToken)	帮助程序函数，用于简化用于调用提示对话框的选项的格式设置。 此帮助程序将采用参数 options ，然后调用 BeginDialogAsync(String, Object, CancellationToken)。
ReplaceDialogAsync(String, Object, CancellationToken)	启动新对话，并将当前处于活动状态的对话替换为新的堆栈。 这对于创建循环或重定向到另一个对话特别有用。
RepromptDialogAsync(CancellationToken)	调用当前活动对话的 RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken) 方法。 与实现重新提示行为的对话框一起使用。

扩展方法

DebuggerStepAsync(DialogContext, OnCondition, DialogEvent, CancellationToken)	调用活动 IDialogDebugger 并使其知道我们处于给定点。
DebuggerStepAsync(DialogContext, Dialog, String, CancellationToken)	调用活动 IDialogDebugger，使其知道我们位于对话框中的给定点。
DebuggerStepAsync(DialogContext, Recognizer, String, CancellationToken)	调用活动 IDialogDebugger，并告知它我们位于识别器中的给定点。
DebuggerStepAsync(DialogContext, IRecognizer, String, CancellationToken)	调用活动 IDialogDebugger，并告知它我们位于识别器中的给定点。
GetDebugger(DialogContext)	用于从 DialogContext 获取 IDialogDebugger 的扩展方法。