TextPrompt 类

  • 参考
包:
com.microsoft.bot.dialogs.prompts
Maven 项目:
com.microsoft.bot:bot-dialogs:4.14.3

public class TextPrompt
extends Prompt<java.lang.String>

提示用户输入文本。

构造函数摘要

构造函数 说明
TextPrompt(String dialogId)

初始化 TextPrompt 类的新实例。
TextPrompt(String dialogId, PromptValidator<String> validator)

初始化 TextPrompt 类的新实例。

方法摘要

修饰符和类型 方法和描述
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

在事件浮升到其父级之前调用。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

提示用户输入。
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<java.lang.String>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

尝试识别用户的输入。

方法继承自 Dialog

beginDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent resumeDialog run setId setTelemetryClient

方法继承自 Prompt

appendChoices beginDialog continueDialog onPreBubbleEvent onPrompt onRecognize repromptDialog resumeDialog

方法继承自 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

构造函数详细信息

TextPrompt

public TextPrompt(String dialogId)

初始化 TextPrompt 类的新实例。

Parameters:

dialogId - 要分配给此提示的 ID。 的值dialogId在添加提示的 或 ComponentDialog 中DialogSet必须是唯一的。

TextPrompt

public TextPrompt(String dialogId, PromptValidator validator)

初始化 TextPrompt 类的新实例。

Parameters:

dialogId - 要分配给此提示的 ID。
validator - 可选，一个 {@link PromptValidator{FoundChoice}}，其中包含对此提示的其他自定义验证。 的值dialogId在添加提示的 或 ComponentDialog 中DialogSet必须是唯一的。

方法详细信息

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

在事件浮升到其父级之前调用。 这是执行事件拦截的好方法，因为返回“true”将防止事件进一步浮升到对话父级，并且还会阻止任何子对话执行其默认处理。

Overrides:

TextPrompt.onPreBubbleEvent(DialogContext dc, DialogEvent e)

Parameters:

dc - 当前会话轮次的对话上下文。
e - 正在引发的事件。

Returns:

事件是否由当前对话处理，并应停止进一步处理。

onPrompt

protected CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options, Boolean isRetry)

提示用户输入。

Overrides:

TextPrompt.onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Parameters:

turnContext - 与用户当前轮次聊天的上下文。
state - 包含对话框堆栈上提示的当前实例的状态。
options - 从调用 prompt(String dialogId, PromptOptions options) 中最初提供的选项构造的提示选项 对象。
isRetry - 如果这是堆栈上的此提示对话框实例首次提示用户输入，则为 true;否则为 false。

Returns:

表示异步操作的 CompletableFuture。

onRecognize

protected CompletableFuture<>> onRecognize(TurnContext turnContext, Map state, PromptOptions options)

尝试识别用户的输入。

Overrides:

TextPrompt.onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Parameters:

turnContext - 与用户当前轮次聊天的上下文。
state - 包含对话框堆栈上提示的当前实例的状态。
options - 从调用 prompt(String dialogId, PromptOptions options) 中最初提供的选项构造的提示选项 对象。

Returns:

表示异步操作的 CompletableFuture。 如果任务成功，则结果描述识别尝试的结果。

适用于