DialogContext.EndDialogAsync(Object, CancellationToken) Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Kończy okno dialogowe przez wyskakujące okienko stosu i zwraca opcjonalny wynik do elementu nadrzędnego okna dialogowego. Okno dialogowe elementu nadrzędnego to okno dialogowe, na których rozpoczęto zakończenie za pośrednictwem wywołania metody BeginDialogAsync(String, Object, CancellationToken) lub PromptAsync(String, PromptOptions, CancellationToken). Okno dialogowe nadrzędne będzie mieć wywołaną metodę ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) z dowolnym zwróconym wynikiem. Jeśli okno dialogowe nadrzędne nie zaimplementowało ResumeDialogAsync metody, zostanie ono również automatycznie zakończone, a wynik przekazany do elementu nadrzędnego.
Jeśli nie ma więcej okien dialogowych nadrzędnych na stosie, przetwarzanie kolei zakończy się.
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)Parametry
- result
- Object
Opcjonalnie wynik przekazywany do kontekstu nadrzędnego.
- cancellationToken
- CancellationToken
Token odwołania, używany przez inne obiekty lub wątki do otrzymania powiadomienia o anulowaniu.
Zwraca
Zadanie reprezentujące wykonaną pracę w kolejce.
Uwagi
Jeśli zadanie zakończy się pomyślnie, wynik wskazuje, że okno dialogowe zostało zakończone po przetworzeniu kolei przez okno dialogowe.
Ogólnie rzecz biorąc, kontekst nadrzędny to okno dialogowe lub program obsługi kolei bota, który uruchomił okno dialogowe. Jeśli element nadrzędny jest okno dialogowe, stos wywołuje metodę elementu nadrzędnego ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) , aby zwrócić wynik do okna dialogowego nadrzędnego. Jeśli okno dialogowe nadrzędne nie implementuje "ResumeDialogAsync", element nadrzędny również zakończy się, a wynik przekazany do następnego kontekstu nadrzędnego.
Zwrócona DialogTurnResult wartość zawiera wartość zwracaną we właściwości Result .