DialogContext.EndDialogAsync(Object, CancellationToken) 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.
Termine un dialogue en le faisant glisser hors de la pile et retourne un résultat facultatif au parent de la boîte de dialogue. La boîte de dialogue parente est la boîte de dialogue démarrée sur en cours de fin via un appel à BeginDialogAsync(String, Object, CancellationToken) ou PromptAsync(String, PromptOptions, CancellationToken). La boîte de dialogue parente a sa ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) méthode appelée avec n’importe quel résultat retourné. Si la boîte de dialogue parente n’a pas implémenté de ResumeDialogAsync méthode, elle est également automatiquement terminée et le résultat est passé à son parent.
S’il n’y a plus de boîtes de dialogue parentes sur la pile, le traitement du tour prend fin.
public System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> EndDialogAsync(object result = default, System.Threading.CancellationToken cancellationToken = default);member this.EndDialogAsync : obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>Public Function EndDialogAsync (Optional result As Object = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)Paramètres
- result
- Object
Facultatif, résultat à passer au contexte parent.
- cancellationToken
- CancellationToken
Jeton d'annulation qui peut être utilisé par d'autres objets ou threads pour être informés de l'annulation.
Retours
Tâche qui représente le travail mis en file d’attente pour s’exécuter.
Remarques
Si la tâche réussit, le résultat indique que le dialogue s’est terminé après que le tour a été traité par le dialogue.
En général, le contexte parent est le gestionnaire de boîte de dialogue ou de tour de bot qui a démarré le dialogue. Si le parent est un dialogue, la pile appelle la méthode du ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) parent pour renvoyer un résultat à la boîte de dialogue parente. Si la boîte de dialogue parente n’implémente pas « ResumeDialogAsync », le parent se termine également et le résultat est passé au contexte parent suivant.
Le retourné DialogTurnResult contient la valeur de retour dans sa Result propriété.