DialogContext.CancelAllDialogsAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| Nom | Description |
|---|---|
| CancelAllDialogsAsync(CancellationToken) |
Supprime toute pile de dialogues existante, ce qui annule tous les dialogues de la pile. |
| CancelAllDialogsAsync(Boolean, String, Object, CancellationToken) |
Supprime toute pile de dialogues existante, ce qui annule tous les dialogues de la pile. |
CancelAllDialogsAsync(CancellationToken)
Supprime toute pile de dialogues existante, ce qui annule tous les dialogues de la pile.
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)
Paramètres
- cancellationToken
- CancellationToken
Jeton d’annulation qui peut être utilisé par d’autres objets ou threads pour recevoir une notification d’annulation.
Retours
Tâche qui représente le travail mis en file d’attente à exécuter.
Remarques
Si la tâche réussit, le résultat indique que les dialogues ont été annulés après le traitement du tour par la boîte de dialogue ou que la pile était déjà vide.
En règle générale, le contexte parent est le gestionnaire de tour de dialogue ou de bot qui a démarré le dialogue. Si le parent est un dialogue, la pile appelle la méthode ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) du parent pour retourner un résultat au dialogue parent. Si la boîte de dialogue parent n’implémente pas « ResumeDialogAsync », alors le parent se termine également, et le résultat est transmis au contexte parent suivant.
Voir aussi
S’applique à
CancelAllDialogsAsync(Boolean, String, Object, CancellationToken)
Supprime toute pile de dialogues existante, ce qui annule tous les dialogues de la pile.
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)
Paramètres
- cancelParents
- Boolean
Si la valeur true, l’annulation se déclenche également par le biais de dialogues parents.
- eventName
- String
Événement.
- eventValue
- Object
Valeur de l’événement.
- cancellationToken
- CancellationToken
Jeton d’annulation qui peut être utilisé par d’autres objets ou threads pour recevoir une notification d’annulation.
Retours
Tâche qui représente le travail mis en file d’attente à exécuter.
Remarques
Si la tâche réussit, le résultat indique que les dialogues ont été annulés après le traitement du tour par la boîte de dialogue ou que la pile était déjà vide.
En règle générale, le contexte parent est le gestionnaire de tour de dialogue ou de bot qui a démarré le dialogue. Si le parent est un dialogue, la pile appelle la méthode ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) du parent pour retourner un résultat au dialogue parent. Si la boîte de dialogue parent n’implémente pas « ResumeDialogAsync », alors le parent se termine également, et le résultat est transmis au contexte parent suivant.