ComponentDialog 类

定义

命名空间:: Microsoft.Bot.Builder.Dialogs

程序集:: Microsoft.Bot.Builder.Dialogs.dll

包:: Microsoft.Bot.Builder.Dialogs v4.22.7

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

由其他对话组成的 Dialog。

public class ComponentDialog : Microsoft.Bot.Builder.Dialogs.DialogContainer

type ComponentDialog = class
    inherit DialogContainer

Public Class ComponentDialog
Inherits DialogContainer

继承: Object

Dialog

DialogContainer
ComponentDialog

注解

组件对话有内部 DialogSet 和 DialogContext，提供一个隐藏于父对话框的内部对话栈。

构造函数

名称	说明
ComponentDialog(String)	初始化 ComponentDialog 类的新实例。

字段

名称	说明
PersistedDialogState	持久化对话框状态的 ID。

属性

名称	说明
Dialogs	获取或设置容器 DialogSet。 (继承自 DialogContainer)
Id	为对话设置或设置id。 (继承自 Dialog)
IgnoreMemoryScopeBinding	获取或设置一个值，指示 DialogContainer 是否应与内存作用域交互。 (继承自 DialogContainer)
InitialDialogId	获取或设置初始对话框的ID。
Source	获取cref=“SourceRange”/>的信息。 (继承自 Dialog)
TelemetryClient	获取或设置用于日志的使用 IBotTelemetryClient 。设置该属性时，所有包含对话 TelemetryClient 的属性也会被设置。 (继承自 DialogContainer)

方法

名称	说明
AddDialog(Dialog)	将新的 Dialog 添加到组件对话框，并返回更新的组件。
BeginDialogAsync(DialogContext, Object, CancellationToken)	启动对话并将其推送到父级对话堆栈时调用。
CheckForVersionChangeAsync(DialogContext, CancellationToken)	CheckForVersionChangeAsync。 (继承自 DialogContainer)
ContinueDialogAsync(DialogContext, CancellationToken)	当对话框继续时调用，该对话是活动对话，用户使用新活动进行答复。
CreateChildContext(DialogContext)	形成一个内部 DialogContext的。
EndComponentAsync(DialogContext, Object, CancellationToken)	在其父上下文中结束组件对话框。
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	对话框结束时调用。
EnsureInitializedAsync(DialogContext)	确保对话已初始化。
FindDialog(String, DialogContext)	查找以前添加到容器中的子对话。使用 DialogContext 作为备份来收集对话。 (继承自 DialogContainer)
FindDialog(String)	查找以前添加到容器中的子对话。 (继承自 DialogContainer)
GetInternalVersion()	GetInternalVersion - 返回此容器的内部版本标识符。 (继承自 DialogContainer)
GetVersion()	获得一个唯一字符串，代表该对话的版本。如果对话框系统之间的版本更改将发出 DialogChanged 事件。 (继承自 Dialog)
OnBeginDialogAsync(DialogContext, Object, CancellationToken)	启动对话并将其推送到父级对话堆栈时调用。
OnComputeId()	构建对话的计算ID。 (继承自 Dialog)
OnContinueDialogAsync(DialogContext, CancellationToken)	当对话框继续时调用，该对话是活动对话，用户使用新活动进行答复。
OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken)	通过使用当前对话或当前对话启动的对话，使用 `DialogContext.emitEvent()`引发事件时调用。 (继承自 DialogContainer)
OnEndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)	对话框结束时调用。
OnInitializeAsync(DialogContext)	初始化对话。
OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	在向所有家长冒泡事件后调用，但未处理。 (继承自 Dialog)
OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)	在将事件气泡到其父级之前调用。 (继承自 Dialog)
OnRepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)	当对话框应重新提示用户输入时调用。
RegisterSourceLocation(String, Int32)	在指定位置注册 cref=“SourceRange”/> 。 (继承自 Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)	当对话框应重新提示用户输入时调用。
ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)	当父对话堆栈上的子对话完成此轮次时调用，并将控件返回到此对话组件。

扩展方法

名称	说明
RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken)	创建对话堆栈并启动对话，将其推送到堆栈上。

适用于