NumberPrompt<T> 类

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

类型参数

T

此提示的数值类型，可以是 int、long、double 或 float。

public class NumberPrompt
extends Prompt<T>

提示用户输入数字。 数字提示当前支持以下类型： float 、、 intlong 、 double 和 decimal 。

构造函数摘要

构造函数 说明
NumberPrompt(String dialogId, PromptValidator<T> validator, Class<T> classOfNumber)

初始化 {@link NumberPrompt{T}} 类的新实例。
NumberPrompt(String dialogId, PromptValidator<T> validator, String defaultLocale, Class<T> classOfNumber)

初始化 {@link NumberPrompt{T}} 类的新实例。
NumberPrompt(String dialogId, Class<T> classOfNumber)

初始化 {@link NumberPrompt{T}} 类的新实例。

方法摘要

修饰符和类型 方法和描述
java.lang.String getDefaultLocale()

获取用于确定提示语言特定行为的默认区域设置。
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<T>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

尝试识别用户的输入。
void setDefaultLocale(String defaultLocale)

设置用于确定提示语言特定行为的默认区域设置。

方法继承自 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

构造函数详细信息

NumberPrompt

public NumberPrompt(String dialogId, PromptValidator validator, Class classOfNumber)

初始化 {@link NumberPrompt{T}} 类的新实例。

Parameters:

dialogId - 对话在其父 DialogSet 或 ComponentDialog 中的唯一 ID。
validator - 每次用户响应提示时都会调用的验证程序。
classOfNumber - 用于在类中确定为其创建的类型的类型。 这是必需的，因为 Java 中的类型擦除不允许在运行时检查 的类型。

Throws:

java.lang.IllegalArgumentException - 如果将 int、long、float 或 double 以外的类型用于 ，则引发 。

NumberPrompt

public NumberPrompt(String dialogId, PromptValidator validator, String defaultLocale, Class classOfNumber)

初始化 {@link NumberPrompt{T}} 类的新实例。

Parameters:

dialogId - 对话在其父 DialogSet 或 ComponentDialog 中的唯一 ID。
validator - 每次用户响应提示时都会调用的验证程序。
defaultLocale - 要使用的区域设置。
classOfNumber - 用于在类中确定为其创建的类型的类型。 这是必需的，因为 Java 中的类型擦除不允许在运行时检查 的类型。

Throws:

java.lang.IllegalArgumentException - 如果将 int、long、float 或 double 以外的类型用于 ，则引发 。

NumberPrompt

public NumberPrompt(String dialogId, Class classOfNumber)

初始化 {@link NumberPrompt{T}} 类的新实例。

Parameters:

dialogId - 对话在其父 DialogSet 或 ComponentDialog 中的唯一 ID。
classOfNumber - 用于在类中确定为其创建的类型的类型。 这是必需的，因为 Java 中的类型擦除不允许在运行时检查 的类型。

Throws:

java.lang.IllegalArgumentException - 如果将 int、long、float 或 double 以外的类型用于 ，则引发 。

方法详细信息

getDefaultLocale

public String getDefaultLocale()

获取用于确定提示语言特定行为的默认区域设置。

Returns:

用于确定提示语言特定行为的默认区域设置。

onPrompt

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

提示用户输入。

Overrides:

NumberPrompt<T>.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:

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

Parameters:

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

Returns:

表示异步操作的 CompletableFuture。 
     If the task is successful, the result describes the result of the
     recognition attempt.

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

设置用于确定提示语言特定行为的默认区域设置。

Parameters:

defaultLocale - 用于确定提示语言特定行为的默认区域设置。

适用于