DialogContainer クラス

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

public abstract class DialogContainer
extends Dialog

一連のダイアログのコンテナー。

コンストラクターの概要

コンストラクター 説明
DialogContainer()

既定のダイアログ ID を持つ新しいインスタンスを作成します。
DialogContainer(String dialogId)

既定のダイアログ ID を持つ新しいインスタンスを作成します。

メソッドの概要

修飾子と型 メソッドと説明
protected java.util.concurrent.CompletableFuture<java.lang.Void> checkForVersionChange(DialogContext dc)

現在のダイアログ インスタンスが開始されてからコンテナーの子ダイアログが変更されているかどうかを確認します。
abstract DialogContext createChildContext(DialogContext dc)

コンテナーのアクティブな子の内部ダイアログ コンテキストを作成します。
Dialog findDialog(String dialogId)

現在のダイアログセットの ID でダイアログを検索します。
DialogSet getDialogs()

ダイアログ をダイアログセットとして返します。
protected java.lang.String getInternalVersion()

このコンテナーの内部バージョン識別子を返します。
java.util.concurrent.CompletableFuture<java.lang.Boolean> onDialogEvent(DialogContext dc, DialogEvent e)

"DialogContext" を使用して、イベントが発生したときに呼び出されます。現在のダイアログまたは現在のダイアログが開始したダイアログによって、Event()' を出力します。
void setTelemetryClient(BotTelemetryClient withTelemetryClient)

ログ記録に使用する BotTelemetryClient を設定します。

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

コンストラクターの詳細

DialogContainer

public DialogContainer()

既定のダイアログ ID を持つ新しいインスタンスを作成します。

DialogContainer

public DialogContainer(String dialogId)

既定のダイアログ ID を持つ新しいインスタンスを作成します。

パラメーター:

dialogId - ダイアログの ID。

メソッドの詳細

checkForVersionChange

protected CompletableFuture checkForVersionChange(DialogContext dc)

現在のダイアログ インスタンスが開始されてからコンテナーの子ダイアログが変更されているかどうかを確認します。 これは、'beginDialog()'、'continueDialog()'、および 'resumeDialog()' の開始時に呼び出す必要があります。

パラメーター:

dc - ダイアログ コンテキスト

戻り値:

CompletableFuture

createChildContext

public abstract DialogContext createChildContext(DialogContext dc)

コンテナーのアクティブな子の内部ダイアログ コンテキストを作成します。

パラメーター:

dc - [親] ダイアログ コンテキスト。

戻り値:

アクティブな子の新しいダイアログ コンテキスト。

findDialog

public Dialog findDialog(String dialogId)

現在の DialogSet の ID でダイアログを検索します。

パラメーター:

dialogId - 検索するダイアログの ID。

戻り値:

見つかった場合のダイアログ。それ以外の場合は null

getDialogs

public DialogSet getDialogs()

ダイアログを DialogSet として返します。

戻り値:

ダイアログの DialogSet。

getInternalVersion

protected String getInternalVersion()

このコンテナーの内部バージョン識別子を返します。

DialogContainers は、コンテナー内のすべてのサブコンポーネントの変更を検出し、DialogChanged イベントにマップします。 これを行うため、DialogContainers は内部の変更を "非表示" にし、.id のみを持っています。これにより、コンテナー が処理しない限り、コンテナー レベルへの変更が分離されます。 この DialogContainers をサポートするために、保護された仮想メソッド getInternalVersion() を定義します。このメソッドは、このダイアログまたは子ダイアログが変更されたかどうかを計算し、checkForVersionChange() の呼び出しによって調べられます。

戻り値:

このコンテナーの内部の変更を表すバージョン。

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

現在のダイアログまたは現在のダイアログが開始したダイアログによって、'DialogContext.emitEvent()' を使用してイベントが発生したときに呼び出されます。

このオーバーライドにより、バージョンの変更がトレースされます。

上書き:

DialogContainer.onDialogEvent(DialogContext dc, DialogEvent e)

パラメーター:

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

戻り値:

True の 場合は、イベントが現在のダイアログで処理され、バブルを停止する必要があります。

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

ログ記録に使用する BotTelemetryClient を設定します。 このプロパティを設定すると、含まれるダイアログのすべての BotTelemetryClient プロパティも設定されます。

上書き:

DialogContainer.setTelemetryClient(BotTelemetryClient withTelemetryClient)

パラメーター:

withTelemetryClient - ログ記録に使用する BotTelemetryClient。

適用対象