DialogContext.EndDialogAsync(Object, CancellationToken) Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Ukončí dialogové okno tak, že ho vysune ze zásobníku a vrátí volitelný výsledek nadřazené části dialogového okna. Nadřazené dialogové okno je dialogové okno, které se spustilo při ukončení voláním na buď BeginDialogAsync(String, Object, CancellationToken) nebo PromptAsync(String, PromptOptions, CancellationToken). Nadřazené dialogové okno bude mít svou ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) metodu vyvolánou s libovolným vráceným výsledkem. Pokud nadřazené dialogové okno neimplementovalo metodu ResumeDialogAsync
, bude automaticky ukončeno a výsledek se předá nadřazené metodě.
Pokud v zásobníku nejsou žádná další nadřazená dialogová okna, zpracování otočení se ukončí.
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
Nepovinný výsledek, který se předá nadřazeného kontextu.
- cancellationToken
- CancellationToken
Token zrušení, který může být použit jinými objekty nebo vlákny k přijetí oznámení o zrušení.
Návraty
Úloha, která představuje práci zařazenou do fronty, která se má provést.
Poznámky
Pokud je úkol úspěšný, výsledek označuje, že dialogové okno skončilo po zpracování otočení dialogem.
Obecně platí, že nadřazený kontext je dialog nebo obslužná rutina otočení robota, která spustila dialogové okno. Pokud je nadřazeným dialogem, zásobník zavolá metodu nadřazeného ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) objektu, aby vrátil výsledek do nadřazeného dialogového okna. Pokud nadřazené dialogové okno neimplementuje ResumeDialogAsync, pak se nadřazený objekt také ukončí a výsledek se předá do dalšího nadřazeného kontextu.
DialogTurnResult Vrácená hodnota obsahuje návratovou hodnotu ve své Result vlastnosti.