DialogContext.CancelAllDialogsAsync Methode

Definition

Überlädt

Name Beschreibung
CancelAllDialogsAsync(CancellationToken)

Löscht alle vorhandenen Dialogstapel, wodurch alle Dialogfelder im Stapel abgebrochen werden.

CancelAllDialogsAsync(Boolean, String, Object, CancellationToken)

Löscht alle vorhandenen Dialogstapel, wodurch alle Dialogfelder im Stapel abgebrochen werden.

CancelAllDialogsAsync(CancellationToken)

Löscht alle vorhandenen Dialogstapel, wodurch alle Dialogfelder im Stapel abgebrochen werden.

public System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> CancelAllDialogsAsync(System.Threading.CancellationToken cancellationToken = default);
member this.CancelAllDialogsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>
Public Function CancelAllDialogsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)

Parameter

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 Dialogfelder abgebrochen wurden, nachdem die Drehung vom Dialogfeld verarbeitet wurde oder dass der Stapel bereits leer war.

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 übergeordnete Dialog 'ResumeDialogAsync' nicht implementiert, endet auch der übergeordnete Dialog und das Ergebnis wird an den nächsten übergeordneten Kontext weitergegeben.

Weitere Informationen

Gilt für:

CancelAllDialogsAsync(Boolean, String, Object, CancellationToken)

Löscht alle vorhandenen Dialogstapel, wodurch alle Dialogfelder im Stapel abgebrochen werden.

public System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> CancelAllDialogsAsync(bool cancelParents, string eventName = default, object eventValue = default, System.Threading.CancellationToken cancellationToken = default);
member this.CancelAllDialogsAsync : bool * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>
Public Function CancelAllDialogsAsync (cancelParents As Boolean, Optional eventName As String = Nothing, Optional eventValue As Object = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)

Parameter

cancelParents
Boolean

Wenn true, wird auch der Abbruch durch alle übergeordneten Dialogfelder angezeigt.

eventName
String

Das Ereignis.

eventValue
Object

Der Ereigniswert.

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 Dialogfelder abgebrochen wurden, nachdem die Drehung vom Dialogfeld verarbeitet wurde oder dass der Stapel bereits leer war.

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 übergeordnete Dialog 'ResumeDialogAsync' nicht implementiert, endet auch der übergeordnete Dialog und das Ergebnis wird an den nächsten übergeordneten Kontext weitergegeben.

Weitere Informationen

Gilt für: