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、int、long、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}} クラスの新しいインスタンスを初期化します。

パラメーター:

dialogId - 親 DialogSet または ComponentDialog 内のダイアログの一意の ID。
validator - ユーザーがプロンプトに応答するたびに呼び出される検証コントロール。
classOfNumber - クラス内で作成された型を決定するために使用される型。 これは、実行時に型をチェックできない Java の型消去が原因で必要です。

スロー:

java.lang.IllegalArgumentException - int、long、float、または double 以外の型が使用されている場合にスローされます。

NumberPrompt

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

{@link NumberPrompt{T}} クラスの新しいインスタンスを初期化します。

パラメーター:

dialogId - 親 DialogSet または ComponentDialog 内のダイアログの一意の ID。
validator - ユーザーがプロンプトに応答するたびに呼び出される検証コントロール。
defaultLocale - 使用するロケール。
classOfNumber - クラス内で作成された型を決定するために使用される型。 これは、実行時に型をチェックできない Java の型消去が原因で必要です。

スロー:

java.lang.IllegalArgumentException - int、long、float、または double 以外の型が使用されている場合にスローされます。

NumberPrompt

public NumberPrompt(String dialogId, Class classOfNumber)

{@link NumberPrompt{T}} クラスの新しいインスタンスを初期化します。

パラメーター:

dialogId - 親 DialogSet または ComponentDialog 内のダイアログの一意の ID。
classOfNumber - クラス内で作成された型を決定するために使用される型。 これは、実行時に型をチェックできない Java の型消去が原因で必要です。

スロー:

java.lang.IllegalArgumentException - int、long、float、または double 以外の型が使用されている場合にスローされます。

メソッドの詳細

getDefaultLocale

public String getDefaultLocale()

プロンプトの言語固有の動作を決定するために使用される既定のロケールを取得します。

戻り値:

プロンプトの言語固有の動作を決定するために使用される既定のロケール。

onPrompt

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

ユーザーに入力を求めます。

上書き:

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

パラメーター:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。
state - ダイアログ スタック上のプロンプトの現在のインスタンスの状態を格納します。
options - プロンプト オプション オブジェクトは、prompt(String dialogId, PromptOptions options) の呼び出しで最初に指定されたオプションから作成されます。
isRetry - スタック上のこのプロンプト ダイアログ インスタンスがユーザーに入力を求めるプロンプトを初めて行う場合は true。それ以外の場合は false。

戻り値:

非同期操作を表す CompletableFuture。

onRecognize

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

ユーザーの入力を認識しようとします。

上書き:

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

パラメーター:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。
state - ダイアログ スタック上のプロンプトの現在のインスタンスの状態を格納します。
options - プロンプト オプション オブジェクトは、prompt(String dialogId, PromptOptions options) の呼び出しで最初に指定されたオプションから作成されます。

戻り値:

非同期操作を表す CompletableFuture。 
     If the task is successful, the result describes the result of the
     recognition attempt.

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

プロンプトの言語固有の動作を決定するために使用する既定のロケールを設定します。

パラメーター:

defaultLocale - プロンプトの言語固有の動作を決定するために使用される既定のロケール。

適用対象