DialogSet クラス

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

public class DialogSet

すべてのユーザーが相互に呼び出すことができる Dialog オブジェクトのコレクション。

コンストラクターの概要

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

状態なしでダイアログセットを作成します。
DialogSet(StatePropertyAccessor<DialogState> withDialogState)

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

メソッドの概要

修飾子と型 メソッドと説明
DialogSet add(Dialog dialog)

セットに新しいダイアログを追加し、fluent チェーンを許可するセットを返します。
java.util.concurrent.CompletableFuture<DialogContext> createContext(TurnContext turnContext)

ダイアログコンテキストを作成します。ダイアログセット内のダイアログを操作するために使用できます。
Dialog find(String dialogId)

現在のダイアログセットの ID でダイアログを検索します。
java.util.Collection<Dialog> getDialogs()

このダイアログセット内のダイアログのコレクションを返します。
BotTelemetryClient getTelemetryClient()

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

このダイアログ セット内のすべてのダイアログの結合バージョンを表す一意の文字列を取得します。
void setTelemetryClient(BotTelemetryClient withBotTelemetryClient)

ログ記録に使用する 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

コンストラクターの詳細

DialogSet

public DialogSet()

状態なしで DialogSet を作成します。

DialogSet

public DialogSet(StatePropertyAccessor withDialogState)

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

このダイアログ セット内のダイアログを開始および制御するには、DialogContext を作成し、そのメソッドを使用してダイアログを開始、続行、または終了します。 ダイアログ コンテキストを作成するには、createContext(TurnContext) を呼び出します。

パラメーター:

withDialogState - このダイアログ セットのスタックを管理する状態プロパティ アクセサー。

メソッドの詳細

add

public DialogSet add(Dialog dialog)

セットに新しいダイアログを追加し、fluent チェーンを許可するセットを返します。 追加する Dialog.Id が既にセットに存在する場合は、ダイアログ ID が更新され、一意のサフィックスが含まれます。 したがって、"duplicate" という名前の 2 つのダイアログをセットに追加すると、最初のダイアログの ID が "duplicate" になり、2 番目のダイアログの ID が "duplicate2" になります。

パラメーター:

dialog - 追加するダイアログ。 追加されたダイアログの Dialog.TelemetryClient は、ダイアログ セットの BotTelemetryClient に設定されます。

戻り値:

操作が完了した後のダイアログ セット。

createContext

public CompletableFuture createContext(TurnContext turnContext)

DialogSet 内のダイアログを操作するために使用できる DialogContext を作成します。

パラメーター:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

戻り値:

非同期操作を表す CompletableFuture。

find

public Dialog find(String dialogId)

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

パラメーター:

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

戻り値:

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

getDialogs

public Collection

getDialogs()

この DialogSet 内のダイアログのコレクションを返します。

戻り値:

この DialogSet のダイアログ。

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

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

戻り値:

ログ記録に使用する BotTelemetryClient。

getVersion

public String getVersion()

このダイアログ セット内のすべてのダイアログの結合バージョンを表す一意の文字列を取得します。

戻り値:

いずれかの子ダイアログのバージョンが変更されると、バージョンが変更されます。

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withBotTelemetryClient)

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

このプロパティを設定すると、セット内の各ダイアログの Dialog.TelemetryClient が新しい値に設定されます。

パラメーター:

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

適用対象