DialogContext.CancelAllDialogsAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| 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", родительский элемент также завершится, и результат передается в следующий родительский контекст.