DialogContext 类
- java.
lang. Object - com.
microsoft. bot. dialogs. DialogContext
- com.
public class DialogContext
为对话堆栈的当前状态提供上下文。
构造函数摘要
构造函数 | 说明 |
---|---|
DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState) |
从轮次上下文初始化 Dialog |
DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState) |
从轮次上下文初始化 Dialog |
方法摘要
方法继承自 java.lang.Object
构造函数详细信息
DialogContext
public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)
从轮次上下文初始化 DialogContext 类的新实例。
参数:
DialogContext
public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)
从轮次上下文初始化 DialogContext 类的新实例。
参数:
方法详细信息
beginDialog
public CompletableFuture
启动新对话并将其推送到对话堆栈上。
参数:
返回:
beginDialog
public CompletableFuture
启动新对话并将其推送到对话堆栈上。
参数:
返回:
cancelAllDialogs
public CompletableFuture
的 cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) 帮助程序方法不会取消父对话或传递 和 事件。
返回:
cancelAllDialogs
public CompletableFuture
删除任何现有对话堆栈,从而取消堆栈上的所有对话。
通常,父上下文是启动对话的对话或机器人轮次处理程序。 如果父级是对话,则堆栈会调用父级的 resumeDialog(DialogContext dc, DialogReason reason, Object result) 方法,以将结果返回给父对话。 如果父对话未实现 Dialog#resumeDialog,则父对话也将结束,并将结果传递到下一个父上下文。
参数:
返回:
continueDialog
public CompletableFuture
继续执行活动对话(如果有),方法是将当前 DialogContext 传递给活动对话的 continueDialog(DialogContext dc) 方法。
返回:
emitEvent
public CompletableFuture
参数:
返回:
emitEvent
public CompletableFuture
参数:
true
。
返回:
endDialog
public CompletableFuture
向 提供 null 结果 endDialog(Object result)的帮助程序方法。
返回:
endDialog
public CompletableFuture
通过将对话从堆栈中弹出来结束对话,并将可选结果返回给对话框的父级。 父对话是通过调用 beginDialog(String dialogId, Object options) 或 prompt(String dialogId, PromptOptions options)结束时启动的对话。 父对话将使用返回的任何结果调用其 resumeDialog(DialogContext dc, DialogReason reason, Object result) 方法。 如果父对话尚未实现 resumeDialog(DialogContext dc, DialogReason reason) 方法,则它也会自动结束,并将结果传递给其父对话。 如果堆栈上没有更多的父对话,则轮次的处理将结束。
参数:
返回:
findDialog
public Dialog findDialog(String dialogId)
查找给定上下文的对话 ID。
参数:
返回:
getActiveDialog
public DialogInstance getActiveDialog()
获取堆栈顶部的活动对话框的缓存实例;如果堆栈为空,则为 null。
返回:
getChild
public DialogContext getChild()
获取子级(如果有活动子级)的对话上下文。
返回:
getContext
public TurnContext getContext()
获取当前会话轮次的上下文。
返回:
getDialogs
public DialogSet getDialogs()
获取当前对话容器处于活动状态的对话集。
返回:
getLocale
public String getLocale()
在 DialogContext 中获取区域设置。
返回:
getParent
public DialogContext getParent()
获取父 DialogContext(如果有)。 在搜索要启动的对话的 ID 时使用。
返回:
getServices
public TurnContextStateCollection getServices()
获取与此对话上下文相关的服务集合。
返回:
getStack
public List
获取当前对话堆栈。
返回:
getState
public DialogStateManager getState()
获取或设置 DialogStateManager,用于管理所有内存范围的视图。
返回:
prompt
public CompletableFuture
帮助程序函数,用于简化用于调用提示对话框的选项的格式设置。 此帮助程序将采用 PromptOptions 参数,然后调用 beginDialog(String dialogId, Object options)
参数:
返回:
replaceDialog
public CompletableFuture
的 replaceDialog(String dialogId, Object options) 帮助程序方法,为选项传递 null。
参数:
返回:
replaceDialog
public CompletableFuture
启动新对话,并将当前处于活动状态的对话替换为新的堆栈。 这对于创建循环或重定向到另一个对话特别有用。
参数:
返回:
repromptDialog
public CompletableFuture
调用当前活动对话的 repromptDialog(TurnContext turnContext, DialogInstance instance) 方法。 与实现重新提示行为的对话框一起使用。
返回:
setParent
public void setParent(DialogContext withDialogContext)
设置父 DialogContext。
参数: