Dialog 类
- java.
lang. Object - com.
microsoft. bot. dialogs. Dialog
- com.
public abstract class Dialog
所有对话框的基类。
字段摘要
修饰符和类型 | 字段和描述 |
---|---|
static final
Dialog |
END_OF_TURN
一个 DialogTurnResult ,指示当前对话仍处于活动状态,并等待用户下一轮的输入。 |
构造函数摘要
构造函数 | 说明 |
---|---|
Dialog(String dialogId) |
初始化 Dialog 类的新实例。 |
方法摘要
修饰符和类型 | 方法和描述 |
---|---|
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(DialogContext dc)
在启动对话并推送到对话堆栈时调用。 |
abstract
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(DialogContext dc, Object options)
在启动对话并推送到对话堆栈时调用。 |
java.util.concurrent.CompletableFuture<Dialog |
continueDialog(DialogContext dc)
当对话为 _continued_时调用,其中它是活动对话,用户使用新活动进行答复。 |
java.util.concurrent.CompletableFuture<java.lang.Void> |
endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)
在对话结束时调用。 |
java.lang.String |
getId()
获取对话框的 ID。 |
Bot |
getTelemetryClient()
获取 BotTelemetryClient 用于日志记录的 。 |
java.lang.String |
getVersion()
获取表示此对话框版本的唯一字符串。 |
protected static
java.util.concurrent.CompletableFuture<Dialog |
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)
在引发事件时调用,使用对话框 |
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<Dialog |
resumeDialog(DialogContext dc, DialogReason reason)
当子对话完成此轮次时调用,将控制权返回到此对话。 |
java.util.concurrent.CompletableFuture<Dialog |
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
字段详细信息
END_OF_TURN
public static final DialogTurnResult END_OF_TURN
一个 DialogTurnResult ,指示当前对话仍处于活动状态,并等待用户下一轮的输入。
构造函数详细信息
Dialog
public Dialog(String dialogId)
初始化 Dialog 类的新实例。
参数:
方法详细信息
beginDialog
public CompletableFuture
在启动对话并推送到对话堆栈时调用。
参数:
返回:
beginDialog
public abstract CompletableFuture
在启动对话并推送到对话堆栈时调用。
参数:
返回:
continueDialog
public CompletableFuture
当对话为 _continued_时调用,其中它是活动对话,用户使用新活动进行答复。
如果此方法被 *not* 重写,则对话框在用户答复时自动结束。
参数:
返回:
endDialog
public CompletableFuture
在对话结束时调用。
参数:
返回:
getId
public String getId()
获取对话框的 ID。
返回:
getTelemetryClient
public BotTelemetryClient getTelemetryClient()
获取 BotTelemetryClient 用于日志记录的 。
返回:
getVersion
public String getVersion()
获取表示此对话框版本的唯一字符串。 如果版本在轮次之间更改,对话系统将发出 DialogChanged 事件。
返回:
innerRun
protected static CompletableFuture
使用 Dialog 和 DialogManager 共享运行的实现。
参数:
返回:
onComputeId
protected String onComputeId()
计算对话框的 ID。
返回:
onDialogEvent
public CompletableFuture
当当前对话或当前对话启动的对话使用'DialogContext.emitEvent () '引发事件时调用。
参数:
返回:
onPostBubbleEvent
protected CompletableFuture
在事件浮升到所有父级且未处理之后调用。
这是为事件执行默认处理逻辑的好地方。 返回“true”将阻止子对话对事件进行任何处理。
参数:
返回:
onPreBubbleEvent
protected CompletableFuture
在事件浮升到其父级之前调用。
这是执行事件拦截的好方法,因为返回“true”将防止事件进一步浮升到对话父级,并且还会阻止任何子对话执行其默认处理。
参数:
返回:
repromptDialog
public CompletableFuture
当对话框应重新提示用户输入时调用。
参数:
返回:
resumeDialog
public CompletableFuture
当子对话完成此轮次时调用,将控制权返回到此对话。
通常,子对话是通过调用 beginDialog(DialogContext dc, Object options) 启动的,但是,如果 replaceDialog(String dialogId) 调用 方法,逻辑子对话可能与原始对话不同。
如果此方法被 *not* 重写,则对话框在用户答复时自动结束。
参数:
返回:
resumeDialog
public CompletableFuture
当子对话完成此轮次时调用,将控制权返回到此对话。
通常,子对话是通过调用 beginDialog(DialogContext dc, Object options) 启动的,但是,如果 replaceDialog(String dialogId, Object options) 调用 方法,逻辑子对话可能与原始对话不同。
如果此方法被 *not* 重写,则对话框在用户答复时自动结束。
参数:
返回:
run
public static CompletableFuture
创建对话堆栈并启动对话,将其推送到堆栈上。
参数:
返回:
setId
public void setId(String withId)
设置对话框的 ID。
参数:
setTelemetryClient
public void setTelemetryClient(BotTelemetryClient withTelemetryClient)
BotTelemetryClient设置用于日志记录的 。
参数: