Prompt<T> 类

  • 参考

定义

命名空间:
Microsoft.Bot.Builder.Dialogs
程序集:
Microsoft.Bot.Builder.Dialogs.dll
包:
Microsoft.Bot.Builder.Dialogs v4.22.7

定义提示对话的核心行为。

public abstract class Prompt<T> : Microsoft.Bot.Builder.Dialogs.Dialog
type Prompt<'T> = class
    inherit Dialog
Public MustInherit Class Prompt(Of T)
Inherits Dialog

类型参数

T

提示返回的值的类型。

继承
Object
Dialog
Prompt<T>
派生

注解

提示结束时，它应返回一个 T 对象，该对象表示提示的值。 使用 Add(Dialog) 或 AddDialog(Dialog) 分别向对话框集或组件对话添加提示。 使用 PromptAsync(String, PromptOptions, CancellationToken) 或 BeginDialogAsync(String, Object, CancellationToken) 启动提示。 如果在 WaterfallDialog中从 WaterfallStep 启动提示，则瀑布的下一步中将提供提示结果。

构造函数

Prompt<T>(String, PromptValidator<T>)

初始化 Prompt<T> 类的新实例。 从派生类中的构造函数调用以初始化 Prompt<T> 类。

属性

Id

获取或设置对话框的 ID。

(继承自 Dialog)
Source

获取 cref=“SourceRange”/>的信息。

(继承自 Dialog)
TelemetryClient

获取或设置用于日志记录的 IBotTelemetryClient。

(继承自 Dialog)

方法

AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, CancellationToken)

在派生类中重写时，在系统提示用户输入时，将选项追加到活动。
AppendChoices(IMessageActivity, String, IList<Choice>, ListStyle, ChoiceFactoryOptions, String, IList<String>, CancellationToken)

在派生类中重写时，在系统提示用户输入时，将选项追加到活动。
BeginDialogAsync(DialogContext, Object, CancellationToken)

当将提示对话推送到对话堆栈并正在激活时调用。
ContinueDialogAsync(DialogContext, CancellationToken)

当提示对话框是活动对话框，用户用新活动答复时调用。
EndDialogAsync(ITurnContext, DialogInstance, DialogReason, CancellationToken)

对话框结束时调用。

(继承自 Dialog)
GetVersion()

获取表示此对话框版本的唯一字符串。 如果对话框系统之间的版本更改将发出 DialogChanged 事件。

(继承自 Dialog)
OnComputeId()

生成对话框的计算 ID。

(继承自 Dialog)
OnDialogEventAsync(DialogContext, DialogEvent, CancellationToken)

通过使用当前对话或当前对话启动的对话，使用 DialogContext.emitEvent()引发事件时调用。

(继承自 Dialog)
OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)

在向所有家长冒泡事件后调用，但未处理。

(继承自 Dialog)
OnPreBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)

在将事件气泡到其父级之前调用。
OnPromptAsync(ITurnContext, IDictionary<String,Object>, PromptOptions, Boolean, CancellationToken)

在派生类中重写时，提示用户输入。
OnRecognizeAsync(ITurnContext, IDictionary<String,Object>, PromptOptions, CancellationToken)

在派生类中重写时，尝试识别用户的输入。
RegisterSourceLocation(String, Int32)

在提供的位置注册 cref=“SourceRange”/>。

(继承自 Dialog)
RepromptDialogAsync(ITurnContext, DialogInstance, CancellationToken)

当请求提示对话框重新提示用户输入时调用。
ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)

当提示对话框恢复为对话堆栈上的活动对话时调用，例如堆栈上以前的活动对话完成时。

扩展方法

RunAsync(Dialog, ITurnContext, IStatePropertyAccessor<DialogState>, CancellationToken)

创建对话堆栈并启动对话，将其推送到堆栈上。

适用于