DialogContext クラス

public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)

ターン コンテキストから DialogContext クラスの新しいインスタンスを初期化します。

パラメーター:

public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

ターン コンテキストから DialogContext クラスの新しいインスタンスを初期化します。

パラメーター:

public CompletableFuture beginDialog(String dialogId)

新しいダイアログを開始し、ダイアログ スタックにプッシュします。

パラメーター:

戻り値:

public CompletableFuture beginDialog(String dialogId, Object options)

新しいダイアログを開始し、ダイアログ スタックにプッシュします。

パラメーター:

戻り値:

public CompletableFuture cancelAllDialogs()

親ダイアログやパスとイベントを取り消さない cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) のヘルパー メソッド。

戻り値:

public CompletableFuture cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)

既存のダイアログ スタックを削除し、スタック上のすべてのダイアログを取り消します。

一般に、親コンテキストは、ダイアログを開始したダイアログまたはボット ターン ハンドラーです。 親がダイアログの場合、スタックは親の resumeDialog(DialogContext dc, DialogReason reason, Object result) メソッドを呼び出して、親ダイアログに結果を返します。 親ダイアログに Dialog#resumeDialogが実装されていない場合、親も終了し、結果は次の親コンテキストに渡されます。

パラメーター:

戻り値:

public CompletableFuture continueDialog()

現在の DialogContext をアクティブなダイアログの continueDialog(DialogContext dc) メソッドに渡すことで、アクティブなダイアログがある場合は、アクティブなダイアログの実行を続行します。

戻り値:

public CompletableFuture emitEvent(String name)

パラメーター:

戻り値:

public CompletableFuture emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)

パラメーター:

戻り値:

public CompletableFuture endDialog()

endDialog(Object result)に null 結果を提供するヘルパー メソッド。

戻り値:

public CompletableFuture endDialog(Object result)

スタックからダイアログをポップして終了し、オプションの結果をダイアログの親に返します。 親ダイアログは、beginDialog(String dialogId, Object options) または prompt(String dialogId, PromptOptions options)の呼び出しを介して開始されたダイアログです。 親ダイアログには、返された結果で resumeDialog(DialogContext dc, DialogReason reason, Object result) メソッドが呼び出されます。 親ダイアログで resumeDialog(DialogContext dc, DialogReason reason) メソッドが実装されていない場合は、自動的に終了し、結果がその親に渡されます。 スタック上にそれ以上親ダイアログがない場合、ターンの処理は終了します。

パラメーター:

戻り値:

public Dialog findDialog(String dialogId)

指定されたコンテキストのダイアログ ID を検索します。

パラメーター:

戻り値:

public DialogInstance getActiveDialog()

スタックの上部にあるアクティブなダイアログのキャッシュされたインスタンスを取得します。スタックが空の場合は null を取得します。

戻り値:

public DialogContext getChild()

アクティブな子がある場合は、子のダイアログ コンテキストを取得します。

戻り値:

public TurnContext getContext()

会話の現在のターンのコンテキストを取得します。

戻り値:

public DialogSet getDialogs()

現在のダイアログ コンテナーでアクティブなダイアログのセットを取得します。

戻り値:

public String getLocale()

DialogContext でロケールを取得します。

戻り値:

public DialogContext getParent()

親 DialogContext (存在する場合) を取得します。 開始するダイアログの ID を検索するときに使用されます。

戻り値:

public TurnContextStateCollection getServices()

このダイアログ コンテキストに依存するサービス コレクションを取得します。

戻り値:

public List getStack()

現在のダイアログ スタックを取得します。

戻り値:

public DialogStateManager getState()

すべてのメモリ スコープのビューを管理する DialogStateManager を取得または設定します。

戻り値:

public CompletableFuture prompt(String dialogId, PromptOptions options)

プロンプト ダイアログを呼び出すためのオプションの書式設定を簡略化するヘルパー関数。 このヘルパーは PromptOptions 引数を受け取り、beginDialog(String dialogId, Object options) を呼び出します。

パラメーター:

戻り値:

public CompletableFuture replaceDialog(String dialogId)

オプションに null を渡す replaceDialog(String dialogId, Object options) のヘルパー メソッド。

パラメーター:

戻り値:

public CompletableFuture replaceDialog(String dialogId, Object options)

新しいダイアログを開始し、スタック上で現在アクティブなダイアログを新しいダイアログに置き換えます。 これは、ループを作成したり、別のダイアログにリダイレクトしたりする場合に特に便利です。

パラメーター:

戻り値:

public CompletableFuture repromptDialog()

現在アクティブなダイアログの repromptDialog(TurnContext turnContext, DialogInstance instance) メソッドを呼び出します。 再プロンプト動作を実装するダイアログで使用されます。

戻り値:

public void setParent(DialogContext withDialogContext)

親 DialogContext を設定します。

パラメーター: