DialogContext.CancelAllDialogsAsync 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
重载
CancelAllDialogsAsync(CancellationToken) |
删除任何现有对话堆栈,从而取消堆栈上的所有对话。 |
CancelAllDialogsAsync(Boolean, String, Object, CancellationToken) |
删除任何现有对话堆栈,从而取消堆栈上的所有对话。 |
CancelAllDialogsAsync(CancellationToken)
删除任何现有对话堆栈,从而取消堆栈上的所有对话。
public System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> CancelAllDialogsAsync (System.Threading.CancellationToken cancellationToken = default);
member this.CancelAllDialogsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>
Public Function CancelAllDialogsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)
参数
- cancellationToken
- CancellationToken
可由其他对象或线程用以接收取消通知的取消标记。
返回
表示排队等待执行的工作的任务。
注解
如果任务成功,则结果指示对话在由对话处理轮次后已取消,或者堆栈已为空。
通常,父上下文是启动对话的对话或机器人轮次处理程序。 如果父级是对话,则堆栈会调用父级的 ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) 方法,以将结果返回给父对话。 如果父对话未实现“ResumeDialogAsync”,则父对话也将结束,并将结果传递到下一个父上下文。
另请参阅
适用于
CancelAllDialogsAsync(Boolean, String, Object, CancellationToken)
删除任何现有对话堆栈,从而取消堆栈上的所有对话。
public System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> CancelAllDialogsAsync (bool cancelParents, string eventName = default, object eventValue = default, System.Threading.CancellationToken cancellationToken = default);
member this.CancelAllDialogsAsync : bool * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>
Public Function CancelAllDialogsAsync (cancelParents As Boolean, Optional eventName As String = Nothing, Optional eventValue As Object = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)
参数
- cancelParents
- Boolean
如果为 true,则取消也会通过任何父对话弹出。
- eventName
- String
事件。
- eventValue
- Object
事件值。
- cancellationToken
- CancellationToken
可由其他对象或线程用以接收取消通知的取消标记。
返回
表示排队等待执行的工作的任务。
注解
如果任务成功,则结果指示对话在由对话处理轮次后已取消,或者堆栈已为空。
通常,父上下文是启动对话的对话或机器人轮次处理程序。 如果父级是对话,则堆栈会调用父级的 ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) 方法,以将结果返回给父对话。 如果父对话未实现“ResumeDialogAsync”,则父对话也将结束,并将结果传递到下一个父上下文。