DateTimePrompt クラス

  • リファレンス
パッケージ:
com.microsoft.bot.dialogs.prompts
Maven 成果物:
com.microsoft.bot:bot-dialogs:4.14.3

public class DateTimePrompt
extends Prompt<java.util.List<DateTimeResolution>>

日付と時刻の値の入力をユーザーに求めます。

コンストラクターの概要

コンストラクター 説明
DateTimePrompt(String dialogId, PromptValidator<List<DateTimeResolution>> validator, String defaultLocale)

DateTimePrompt クラスの新しいインスタンスを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
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<java.util.List<DateTimeResolution>>> 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

コンストラクターの詳細

DateTimePrompt

public DateTimePrompt(String dialogId, PromptValidator<>> validator, String defaultLocale)

DateTimePrompt クラスの新しいインスタンスを初期化します。

Parameters:

dialogId - このプロンプトに割り当てる ID。
validator - 省略可能。 PromptValidator.FoundChoice このプロンプトの追加のカスタム検証を含む 。
defaultLocale - 省略可能。プロンプトの言語固有の動作を決定するために使用される既定のロケール。 ロケールは、言語または言語ファミリを表す 2、3、または 4 文字の ISO 639 コードです。 
                  The value of <xref uid="" data-throw-if-not-resolved="false" data-raw-source="dialogId"></xref> must be unique within the
                  <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="DialogSet"></xref> or <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="ComponentDialog"></xref> to which
                  the prompt is added. If the <xref uid="com.microsoft.bot.schema.Activity.locale" data-throw-if-not-resolved="false" data-raw-source="Activity#locale"></xref> of
                  the <xref uid="com.microsoft.bot.dialogs.DialogContext" data-throw-if-not-resolved="false" data-raw-source="DialogContext"></xref> .<xref uid="com.microsoft.bot.dialogs.DialogContext.context" data-throw-if-not-resolved="false" data-raw-source="DialogContext#context"></xref>
                  .<xref uid="" data-throw-if-not-resolved="false" data-raw-source="ITurnContext#activity"></xref> is specified, then that
                  local is used to determine language specific behavior;
                  otherwise the <xref uid="" data-throw-if-not-resolved="false" data-raw-source="defaultLocale"></xref> is used. US-English
                  is the used if no language or default locale is
                  available, or if the language or locale is not otherwise
                  supported.

メソッドの詳細

getDefaultLocale

public String getDefaultLocale()

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

Returns:

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

onPrompt

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

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

Overrides:

DateTimePrompt.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:

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

Parameters:

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

Returns:

非同期操作を表す CompletableFuture。 タスクが成功した場合、結果には認識試行の結果が記述されます。

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

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

Parameters:

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

適用対象