Share via


InputDialog 类

定义

定义输入对话框。

public abstract class InputDialog : Microsoft.Bot.Builder.Dialogs.Dialog
type InputDialog = class
    inherit Dialog
Public MustInherit Class InputDialog
Inherits Dialog
继承
InputDialog
派生

构造函数

InputDialog()

定义输入对话框。

字段

TURN_COUNT_PROPERTY

定义对话上下文轮次计数属性值。

VALUE_PROPERTY

定义对话框上下文状态属性值。

属性

AllowInterruptions

获取或设置 intteruption 策略。

AlwaysPrompt

获取或设置一个值,该值指示无论是否存在值,输入是否应始终提示用户。

DefaultValue

获取或设置超出 MaxTurnCount 时输入对话框的默认值。

DefaultValueResponse

获取或设置在达到 MaxTurnCount 并使用默认值时发送的活动模板。

Disabled

获取或设置是否应禁用此操作。

Id

获取或设置对话框的 ID。

(继承自 Dialog)
InvalidPrompt

获取或设置每当提供的值无效时要发送给用户的活动模板。

MaxTurnCount

获取或设置在对话框放弃之前要求用户输入此值的最大次数。

Prompt

获取或设置要发送给用户的活动。

Property

获取或设置值将绑定到的内存属性路径。

Source

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

(继承自 Dialog)
TelemetryClient

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

(继承自 Dialog)
UnrecognizedPrompt

获取或设置用于重试的活动模板。

Validations

获取或设置要运行的表达式以验证输入。

Value

获取或设置用于将输入绑定到对话框的表达式。

方法

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

AppendChoices 是在给定所有选项的情况下生成消息活动的实用工具方法。

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)
OnInitializeOptions(DialogContext, Object)

处理选项的方法。

OnPostBubbleEventAsync(DialogContext, DialogEvent, CancellationToken)

在事件浮升到所有父级且未处理之后调用。

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

在事件浮升到其父级之前调用。

OnRecognizeInputAsync(DialogContext, CancellationToken)

在收到输入时调用,重写此方法以自定义输入的识别。

OnRenderPromptAsync(DialogContext, InputState, CancellationToken)

向用户呈现提示的方法为 n 提供当前输入状态。

RegisterSourceLocation(String, Int32)

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

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

当对话框应重新提示用户输入时调用。

(继承自 Dialog)
ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken)

在子对话完成轮次时调用,将控制权返回到此对话。

扩展方法

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

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

适用于