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
为 endDialog(Object result)提供 null 结果的帮助程序方法。
返回:
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
用于传递选项 null 的 replaceDialog(String dialogId, Object options) 的帮助程序方法。
参数:
返回:
replaceDialog
public CompletableFuture
启动一个新对话框,并将当前活动对话替换为新对话的堆栈。 这对于创建循环或重定向到另一个对话特别有用。
参数:
返回:
repromptDialog
public CompletableFuture
调用当前活动对话框的 repromptDialog(TurnContext turnContext, DialogInstance instance) 方法。 与实现重新提示行为的对话框一起使用。
返回:
setParent
public void setParent(DialogContext withDialogContext)
设置父 DialogContext。
参数: