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()

返回此对话集中的 Dialogs 集合。
BotTelemetryClient getTelemetryClient()

获取用于日志记录的机器人遥测客户端。
java.lang.String getVersion()

获取一个唯一字符串，表示此对话集中所有对话的组合版本。
void setTelemetryClient(BotTelemetryClient withBotTelemetryClient)

设置机器人遥测客户端用于日志记录。

方法继承自 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 将更新为包含一个后缀，使其唯一。 因此，向集中添加 2 个名为“duplicate”的对话框将导致第一个对话框的 ID 为“duplicate”，第二个对话框的 ID 为“duplicate2”。

参数:

dialog - 要添加的对话。 添加的对话 Dialog.TelemetryClient 设置为对话框集的 BotTelemetryClient。

返回:

作完成后设置的对话。

createContext

public CompletableFuture createContext(TurnContext turnContext)

创建一个 DialogContext，该对话框可用于处理 DialogSet 中的对话。

参数:

turnContext - 与用户的当前会话轮次的上下文。

返回:

表示异步作的 CompletableFuture。

find

public Dialog find(String dialogId)

按其 ID 在当前 DialogSet 中搜索对话框。

参数:

dialogId - 要搜索的对话框的 ID。

返回:

如果找到，则为对话框;否则为 null

getDialogs

public Collection

getDialogs()

返回此 DialogSet 中的 Dialogs 集合。

返回:

此 DialogSet 中的对话。

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

获取用于日志记录的 BotTelemetryClient。

返回:

用于日志记录的 BotTelemetryClient。

getVersion

public String getVersion()

获取一个唯一字符串，表示此对话集中所有对话的组合版本。

返回:

当任何子对话版本发生更改时，版本将更改。

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withBotTelemetryClient)

设置用于日志记录的 BotTelemetryClient。

设置此属性后，会将集中每个对话框的 Dialog.TelemetryClient 设置为新值。

参数:

withBotTelemetryClient - 用于日志记录的 BotTelemetryClient。

适用于