Dialog クラス

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

public abstract class Dialog

すべてのダイアログの基本クラス。

フィールドの概要

修飾子と型 フィールドと説明
static final DialogTurnResult END_OF_TURN

現在のダイアログがまだアクティブであり、ユーザーの次のターンからの入力を待機していることを示す DialogTurnResult。

コンストラクターの概要

コンストラクター 説明
Dialog(String dialogId)

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

メソッドの概要

修飾子と型 メソッドと説明
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc)

ダイアログが開始され、ダイアログ スタックにプッシュされたときに呼び出されます。
abstract 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 getId()

ダイアログの ID を取得します。
BotTelemetryClient getTelemetryClient()

ログ記録に使用する BotTelemetryClient を取得します。
java.lang.String getVersion()

このダイアログのバージョンを表す一意の文字列を取得します。
protected static java.util.concurrent.CompletableFuture<DialogTurnResult> innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

ダイアログとダイアログマネージャーを使用した実行の共有実装。
protected java.lang.String onComputeId()

ダイアログの ID を計算します。
java.util.concurrent.CompletableFuture<java.lang.Boolean> onDialogEvent(DialogContext dc, DialogEvent e)

"DialogContext" を使用して、イベントが発生したときに呼び出されます。現在のダイアログまたは現在のダイアログが開始したダイアログによって、Event()' を出力します。
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPostBubbleEvent(DialogContext dc, DialogEvent e)

イベントがすべての親にバブルされた後に呼び出され、処理されませんでした。
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

イベントが親にバブルされる前に呼び出されます。
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

ダイアログがユーザーに入力を再度求める必要があるときに呼び出されます。
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason)

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

子ダイアログがこのターンを完了したときに呼び出され、このダイアログにコントロールが返されます。
static java.util.concurrent.CompletableFuture<java.lang.Void> run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor<DialogState> accessor)

ダイアログ スタックを作成し、ダイアログを開始してスタックにプッシュします。
void setId(String withId)

ダイアログの ID を設定します。
void setTelemetryClient(BotTelemetryClient withTelemetryClient)

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

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

フィールドの詳細

END_OF_TURN

public static final DialogTurnResult END_OF_TURN

現在のダイアログがまだアクティブであり、ユーザーの次のターンからの入力を待機していることを示す DialogTurnResult。

コンストラクターの詳細

Dialog

public Dialog(String dialogId)

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

パラメーター:

dialogId - このダイアログに割り当てる ID。

メソッドの詳細

beginDialog

public CompletableFuture beginDialog(DialogContext dc)

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

パラメーター:

dc - 会話の現在のターンの DialogContext。

戻り値:

タスクが成功した場合、結果は、ダイアログによってターンが処理された後もダイアログがアクティブかどうかを示します。

beginDialog

public abstract CompletableFuture beginDialog(DialogContext dc, Object options)

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

パラメーター:

dc - 会話の現在のターンの DialogContext。
options - ダイアログに渡す初期情報。

戻り値:

タスクが成功した場合、結果は、ダイアログによってターンが処理された後もダイアログがアクティブかどうかを示します。

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

このメソッドがオーバーライドされた *not* の場合、ユーザーが応答したときにダイアログが自動的に終了します。

パラメーター:

dc - 会話の現在のターンの DialogContext。

戻り値:

タスクが成功した場合、結果は、ダイアログによってターンが処理された後もダイアログがアクティブかどうかを示します。 結果に戻り値が含まれる場合もあります。

endDialog

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

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

パラメーター:

turnContext - このターンのコンテキスト オブジェクト。
instance - ダイアログ スタック上のこのダイアログのインスタンスに関連付けられている状態情報。
reason - ダイアログが終了した理由。

戻り値:

非同期操作を表す CompletableFuture。

getId

public String getId()

ダイアログの ID を取得します。

戻り値:

ダイアログの ID。

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

ログ記録に使用する BotTelemetryClient を取得します。

戻り値:

ログ記録に使用する BotTelemetryClient。

getVersion

public String getVersion()

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

戻り値:

ダイアログを再起動する方法でダイアログが変更された場合にのみ変更する必要がある一意の文字列。

innerRun

protected static CompletableFuture innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Dialog と DialogManager を使用した実行の共有実装。

パラメーター:

turnContext - turnContext。
dialogId - ダイアログの ID。
dialogContext - DialogContext。
stateConfiguration - DialogStateManagerConfiguration。

戻り値:

DialogTurnResult。

onComputeId

protected String onComputeId()

ダイアログの ID を計算します。

戻り値:

ID。

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

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

パラメーター:

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

戻り値:

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

onPostBubbleEvent

protected CompletableFuture onPostBubbleEvent(DialogContext dc, DialogEvent e)

イベントがすべての親にバブルされた後に呼び出され、処理されませんでした。

これは、イベントの既定の処理ロジックを実行するのに適した場所です。 'true' を返すと、子ダイアログによるイベントの処理が禁止されます。

パラメーター:

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

戻り値:

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

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

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

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

パラメーター:

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

戻り値:

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

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

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

パラメーター:

turnContext - このターンのコンテキスト オブジェクト。
instance - このダイアログの状態情報。

戻り値:

非同期操作を表す CompletableFuture。

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason)

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

一般に、子ダイアログは beginDialog(DialogContext dc, Object options) の呼び出しで開始されましたが、replaceDialog(String dialogId) メソッドが呼び出された場合、論理子ダイアログは元のダイアログとは異なる場合があります。

このメソッドがオーバーライドされた *not* の場合、ユーザーが応答したときにダイアログが自動的に終了します。

パラメーター:

dc - 会話の現在のターンのダイアログ コンテキスト。
reason - ダイアログが再開された理由。

戻り値:

タスクが成功した場合、結果は、このダイアログ ターンが処理された後もこのダイアログがアクティブかどうかを示します。

resumeDialog

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

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

一般に、子ダイアログは beginDialog(DialogContext dc, Object options) の呼び出しで開始されましたが、replaceDialog(String dialogId, Object options) メソッドが呼び出された場合、論理子ダイアログは元のダイアログとは異なる場合があります。

このメソッドがオーバーライドされた *not* の場合、ユーザーが応答したときにダイアログが自動的に終了します。

パラメーター:

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

戻り値:

タスクが成功した場合、結果は、このダイアログ ターンが処理された後もこのダイアログがアクティブかどうかを示します。

run

public static CompletableFuture run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor accessor)

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

パラメーター:

dialog - 開始するダイアログ。
turnContext - 会話の現在のターンのコンテキスト。
accessor - ダイアログ スタックの状態を管理する StatePropertyAccessor アクセサー。

戻り値:

非同期操作を表すタスク。

setId

public void setId(String withId)

ダイアログの ID を設定します。

パラメーター:

withId - ダイアログの ID。

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

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

パラメーター:

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

適用対象