Prompt<T> クラス

型パラメーター

T

プロンプトの作成対象を入力します。

public abstract class Prompt
extends Dialog

プロンプト ダイアログの主要な動作を定義します。 プロンプトが終了すると、プロンプトが表示された値を表すオブジェクトが返されます。 ダイアログ セットまたはコンポーネント ダイアログにプロンプトを追加するには、add(Dialog dialog) または addDialog(Dialog dialog) を使用します。 prompt(String dialogId, PromptOptions options) または beginDialog(String dialogId, Object options) を使用してプロンプトを開始します。 WaterfallDialogWaterfallStep からプロンプトを開始すると、ウォーターフォールの次の手順でプロンプトの結果を使用できるようになります。

フィールドの概要

修飾子と型 フィールドと説明
static final java.lang.String ATTEMPTCOUNTKEY

コンストラクターの概要

コンストラクター 説明
Prompt(String dialogId, PromptValidator<T> validator)

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

メソッドの概要

修飾子と型 メソッドと説明
protected Activity appendChoices(Activity prompt, String channelId, List<Choice> choices, ListStyle style, ChoiceFactoryOptions options)

派生クラスでオーバーライドされると、ユーザーが入力を求められたときにアクティビティに選択肢を追加します。

java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

プロンプト ダイアログがダイアログ スタックにプッシュされ、アクティブ化されるときに呼び出されます。

java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

プロンプト ダイアログがアクティブなダイアログであり、ユーザーが新しいアクティビティで応答したときに呼び出されます。

protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

イベントが親にバブルされる前に呼び出されます。

protected abstract java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

派生クラスでオーバーライドされると、ユーザーに入力を求めます。

protected abstract java.util.concurrent.CompletableFuture<PromptRecognizerResult<T>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

派生クラスでオーバーライドされると、ユーザーの入力を認識しようとします。

java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

ユーザーに入力を再度求めるプロンプト ダイアログが要求されたときに呼び出されます。

java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

以前のアクティブなダイアログが完了したときなど、ダイアログ スタック上のアクティブなダイアログとしてプロンプト ダイアログが再開されたときに呼び出されます。

メソッドの継承元: Dialog

メソッドの継承元: 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

フィールドの詳細

ATTEMPTCOUNTKEY

public static final String ATTEMPTCOUNTKEY

コンストラクターの詳細

Prompt

public Prompt(String dialogId, PromptValidator validator)

{@link Prompt{T}} クラスの新しいインスタンスを初期化します。 {@link Prompt{T}} クラスを初期化するために、派生クラスのコンストラクターから呼び出されます。

パラメーター:

dialogId - このプロンプトに割り当てる ID。
validator - 省略可能。このプロンプトの追加のカスタム検証を含む {@link PromptValidator{T}} です。
              The value of dialogId must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.bot.dialogs.DialogSet"></xref> or
              <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.bot.dialogs.ComponentDialog"></xref> to which
              the prompt is added.

メソッドの詳細

appendChoices

protected Activity appendChoices(Activity prompt, String channelId, List choices, ListStyle style, ChoiceFactoryOptions options)

派生クラスでオーバーライドされると、ユーザーが入力を求められたときにアクティビティに選択肢を追加します。

パラメーター:

prompt - 選択肢を追加するアクティビティ。
channelId - ユーザーのチャネルの ID。
choices - 追加する選択肢。
style - ユーザーに選択肢を表示する方法を示します。
options - 選択肢を表示するときに使用する書式設定オプション。

戻り値:

非同期操作を表す CompletableFuture
     If the task is successful, the result contains the updated activity.

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

プロンプト ダイアログがダイアログ スタックにプッシュされ、アクティブ化されるときに呼び出されます。

上書き:

Prompt<T>.beginDialog(DialogContext dc, Object options)

パラメーター:

dc - 会話の現在のターンのダイアログ コンテキスト。
options - オプション。開始中のプロンプトに渡す追加情報。

戻り値:

非同期操作を表す CompletableFuture
     If the task is successful, the result indicates whether the prompt is
     still active after the turn has been processed by the prompt.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

プロンプト ダイアログがアクティブなダイアログであり、ユーザーが新しいアクティビティで応答したときに呼び出されます。

上書き:

Prompt<T>.continueDialog(DialogContext dc)

パラメーター:

dc - 会話の現在のターンのダイアログ コンテキスト。

戻り値:

非同期操作を表す CompletableFuture
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     prompt generally continues to receive the user's replies until it
     accepts the user's reply as valid input for the prompt.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

イベントが親にバブルされる前に呼び出されます。 これは、イベントのインターセプトを実行するのに適しています。'true' を返すと、ダイアログの親にイベントがさらにバブルするのを防ぎ、子ダイアログが既定の処理を実行することもできなくなります。

上書き:

Prompt<T>.onPreBubbleEvent(DialogContext dc, DialogEvent e)

パラメーター:

dc - 会話の現在のターンのダイアログ コンテキスト。
e - 発生しているイベント。

戻り値:

イベントが現在のダイアログで処理され、さらに処理が停止するかどうか。

onPrompt

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

派生クラスでオーバーライドされると、ユーザーに入力を求めます。

パラメーター:

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

戻り値:

非同期操作を表す CompletableFuture

onRecognize

protected abstract CompletableFuture> onRecognize(TurnContext turnContext, Map 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.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

ユーザーに入力を再度求めるプロンプト ダイアログが要求されたときに呼び出されます。

上書き:

Prompt<T>.repromptDialog(TurnContext turnContext, DialogInstance instance)

パラメーター:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。
instance - スタック上のダイアログのインスタンス。

戻り値:

非同期操作を表す CompletableFuture

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

以前のアクティブなダイアログが完了したときなど、ダイアログ スタック上のアクティブなダイアログとしてプロンプト ダイアログが再開されたときに呼び出されます。

上書き:

Prompt<T>.resumeDialog(DialogContext dc, DialogReason reason, Object result)

パラメーター:

dc - 会話の現在のターンのダイアログ コンテキスト。
reason - ダイアログが再開された理由を示す列挙型。
result - 省略可能。スタック上の前のダイアログから返された値。 返される値の型は、前のダイアログに依存します。

戻り値:

非同期操作を表す CompletableFuture
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

適用対象