DialogContext.EndDialogAsync(Object, CancellationToken) Methode

Definition

Beendet ein Dialogfeld, indem es aus dem Stapel geknallt wird, und gibt ein optionales Ergebnis an das übergeordnete Dialogfeld zurück. Das übergeordnete Dialogfeld ist das Dialogfeld, das über einen Aufruf von oder BeginDialogAsync(String, Object, CancellationToken)PromptAsync(String, PromptOptions, CancellationToken)beendet wird. Im übergeordneten Dialogfeld wird die ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) -Methode mit jedem zurückgegebenen Ergebnis aufgerufen. Wenn das übergeordnete Dialogfeld keine ResumeDialogAsync Methode implementiert hat, wird sie automatisch beendet und das Ergebnis an das übergeordnete Element übergeben. Wenn keine übergeordneten Dialoge mehr auf dem Stapel vorhanden sind, wird die Verarbeitung des Drehs beendet.

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)

Parameter

result
Object

Optional: Ergebnis, das an den übergeordneten Kontext übergeben werden soll.

cancellationToken
CancellationToken

Ein Abbruchtoken, das von anderen Objekten oder Threads verwendet werden kann, um Nachricht vom Abbruch zu empfangen.

Gibt zurück

Eine Aufgabe, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, dass der Dialog beendet wurde, nachdem der Umdrehung durch das Dialogfeld verarbeitet wurde.

Im Allgemeinen ist der übergeordnete Kontext der Dialog- oder Bot-Turnhandler, der das Dialogfeld gestartet hat. Wenn das übergeordnete Dialogfeld ein Dialog ist, ruft der Stapel die Methode des ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) übergeordneten Elements auf, um ein Ergebnis an das übergeordnete Dialogfeld zurückzugeben. Wenn das übergeordnete Dialogfeld "ResumeDialogAsync" nicht implementiert, wird auch das übergeordnete Element beendet, und das Ergebnis wird an den nächsten übergeordneten Kontext übergeben.

Der zurückgegebene DialogTurnResult enthält den Rückgabewert in seiner Result Eigenschaft.

Gilt für:

Weitere Informationen