ComponentDialog.EndComponentAsync Methode

Definition

Beendet das Komponentendialogfeld im Kontext des übergeordneten Elements.

protected virtual System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> EndComponentAsync(Microsoft.Bot.Builder.Dialogs.DialogContext outerDc, object result, System.Threading.CancellationToken cancellationToken);
abstract member EndComponentAsync : Microsoft.Bot.Builder.Dialogs.DialogContext * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>
override this.EndComponentAsync : Microsoft.Bot.Builder.Dialogs.DialogContext * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>
Protected Overridable Function EndComponentAsync (outerDc As DialogContext, result As Object, cancellationToken As CancellationToken) As Task(Of DialogTurnResult)

Parameter

outerDc
DialogContext

Das übergeordnete DialogContext für die aktuelle Unterhaltungswende.

result
Object

Optionaler Wert, der von der Dialogkomponente in den übergeordneten Kontext zurückgegeben werden soll.

cancellationToken
CancellationToken

Ein Abbruchtoken, das von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.

Gibt zurück

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

Hinweise

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, dass das Dialogfeld beendet wurde, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

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

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

Gilt für:

Weitere Informationen