WaterfallDialog クラス

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

public class WaterfallDialog
extends Dialog

ユーザーに一連の質問を求めるよう最適化されたダイアログ。 ウォーターフォールは、順番に実行される関数のスタックを受け入れます。 各ウォーターフォール ステップはユーザーの質問をすることができ、ユーザーの応答は次のウォーターフォール ステップの引数として渡されます。

コンストラクターの概要

コンストラクター 説明
WaterfallDialog(String dialogId, List<WaterfallStep> actions)

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

メソッドの概要

修飾子と型 メソッドと説明
WaterfallDialog addStep(WaterfallStep step)

ウォーターフォールに新しいステップを追加します。
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

ウォーターフォール ダイアログが開始され、ダイアログ スタックにプッシュされたときに呼び出されます。
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

ウォーターフォール ダイアログが _continued_ の場合に呼び出されます。このダイアログはアクティブなダイアログであり、ユーザーは新しいアクティビティで応答します。
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

ダイアログが終了するときに呼び出されます。
java.lang.String getVersion()

このダイアログのバージョンを表す一意の文字列を取得します。
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onStep(WaterfallStepContext stepContext)

個々のウォーターフォール ステップが実行されるときに呼び出されます。
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

子ウォーターフォール ダイアログがターンを完了し、このダイアログにコントロールを返すと呼び出されます。
protected java.util.concurrent.CompletableFuture<DialogTurnResult> runStep(DialogContext dc, int index, DialogReason reason, Object result)

ウォーターフォール ダイアログのステップを実行します。

メソッドの継承元: Dialog

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

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

コンストラクターの詳細

WaterfallDialog

public WaterfallDialog(String dialogId, List actions)

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

パラメーター:

dialogId - ダイアログ ID。
actions - 呼び出し元によって定義されるオプションのアクション。

メソッドの詳細

addStep

public WaterfallDialog addStep(WaterfallStep step)

ウォーターフォールに新しいステップを追加します。

パラメーター:

step - 追加する手順。

戻り値:

AddStep()への流暢な呼び出しのためのウォーターフォール ダイアログ。

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

ウォーターフォール ダイアログが開始され、ダイアログ スタックにプッシュされたときに呼び出されます。

上書き:

WaterfallDialog.beginDialog(DialogContext dc, Object options)

パラメーター:

dc - ザ
options - オプション。ダイアログに渡す初期情報。

戻り値:

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

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

ウォーターフォール ダイアログが _continued_ の場合に呼び出されます。このダイアログはアクティブなダイアログであり、ユーザーは新しいアクティビティで応答します。

上書き:

WaterfallDialog.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
     result may also contain a return value.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

ダイアログが終了するときに呼び出されます。

上書き:

WaterfallDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

パラメーター:

turnContext - 会話の現在のターンのコンテキスト。
instance - 現在のダイアログのインスタンス。
reason - ダイアログが終了する理由。

戻り値:

実行するキューに登録された作業を表すタスク。

getVersion

public String getVersion()

このダイアログのバージョンを表す一意の文字列を取得します。 バージョンが変更された場合、ダイアログ システムは DialogChanged イベントを生成します。

上書き:

WaterfallDialog.getVersion()

戻り値:

ステップ数の変更時にバージョンが変更されます (ダイアログにはステップの内容を評価する方法がないためです)。

onStep

protected CompletableFuture onStep(WaterfallStepContext stepContext)

個々のウォーターフォール ステップが実行されるときに呼び出されます。

パラメーター:

stepContext - ウォーターフォール ステップを実行するためのコンテキスト。

戻り値:

実行するキューに登録された作業を表すタスク。

resumeDialog

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

子ウォーターフォール ダイアログがターンを完了し、このダイアログにコントロールを返すと呼び出されます。

上書き:

WaterfallDialog.resumeDialog(DialogContext dc, DialogReason reason, Object result)

パラメーター:

dc - 会話の現在のターンのダイアログ コンテキスト。
reason - ダイアログが再開された理由。
result - オプション。呼び出されたダイアログから返される値。 返される値の型は、子ダイアログに依存します。

戻り値:

非同期操作を表す CompletableFuture。

runStep

protected CompletableFuture runStep(DialogContext dc, int index, DialogReason reason, Object result)

ウォーターフォール ダイアログのステップを実行します。

パラメーター:

dc - 会話の現在のターンの DialogContext。
index - 実行する現在のウォーターフォール ステップのインデックス。
reason - ウォーターフォール ステップが実行されている理由。
result - 前のウォーターフォール ステップで呼び出されたダイアログによって返される結果。

戻り値:

実行するキューに登録された作業を表すタスク。

適用対象