WaterfallStepContext クラス

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

public class WaterfallStepContext
extends DialogContext

WaterfallDialog のステップのコンテキストを提供します。 DialogContext プロパティには、現在のターンの TurnContext が含まれています。

コンストラクターの概要

コンストラクター 説明
WaterfallStepContext(WaterfallDialog parentWaterfall, DialogContext dc, Object options, Map<String,Object> values, int index, DialogReason reason, Object result)

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

メソッドの概要

修飾子と型 メソッドと説明
int getIndex()

実行中の現在のウォーターフォール ステップのインデックスを取得します。
java.lang.Object getOptions()

ウォーターフォール ダイアログが呼び出されたオプションを取得します。
DialogReason getReason()

ウォーターフォール ステップが実行されている理由を取得します。
java.lang.Object getResult()

前のウォーターフォール ステップの結果を取得します。
java.util.Map<java.lang.String,java.lang.Object> getValues()

すべてのウォーターフォール アクションで永続化される値のディクショナリを取得します。
java.util.concurrent.CompletableFuture<DialogTurnResult> next(Object result)

ウォーターフォールの次のステップに進みます。

メソッドの継承元: DialogContext

beginDialog beginDialog cancelAllDialogs cancelAllDialogs continueDialog emitEvent emitEvent endDialog endDialog findDialog getActiveDialog getChild getContext getDialogs getLocale getParent getServices getStack getState prompt replaceDialog replaceDialog repromptDialog setParent

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

コンストラクターの詳細

WaterfallStepContext

public WaterfallStepContext(WaterfallDialog parentWaterfall, DialogContext dc, Object options, Map values, int index, DialogReason reason, Object result)

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

パラメーター:

parentWaterfall - ウォーターフォール ダイアログの親。
dc - ダイアログのコンテキスト。
options - ウォーターフォール ダイアログを呼び出すオプション。
values - すべてのウォーターフォール ステップで永続化される値のディクショナリ。
index - 実行する現在のウォーターフォールのインデックス。
reason - ウォーターフォール ステップが実行されている理由。
result - 前のウォーターフォール ステップで呼び出されたダイアログによって返される結果。

メソッドの詳細

getIndex

public int getIndex()

実行中の現在のウォーターフォール ステップのインデックスを取得します。

戻り値:

はインデックス値を返します。

getOptions

public Object getOptions()

ウォーターフォール ダイアログが呼び出されたオプションを取得します。

戻り値:

オプション。

getReason

public DialogReason getReason()

ウォーターフォール ステップが実行されている理由を取得します。

戻り値:

The DialogReason

getResult

public Object getResult()

前のウォーターフォール ステップの結果を取得します。 結果は、多くの場合、ウォーターフォールの前の手順で開始された子ダイアログの戻り値です。

戻り値:

結果の値。

getValues

public Map getValues()

すべてのウォーターフォール アクションで永続化される値のディクショナリを取得します。

戻り値:

値のディクショナリ。

next

public CompletableFuture next(Object result)

ウォーターフォールの次のステップに進みます。

パラメーター:

result - 省略可能。現在のウォーターフォール ダイアログの次のステップに渡す結果。

戻り値:

実行するキューに登録された作業を表す CompletableFuture。 ウォーターフォールの次のステップでは、ウォーターフォール ステップ コンテキストの result プロパティに > の値が含まれます。

適用対象