Freigeben über


DialogContext.CancelAllDialogsAsync Methode

Definition

Überlädt

CancelAllDialogsAsync(CancellationToken)

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

CancelAllDialogsAsync(Boolean, String, Object, CancellationToken)

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

CancelAllDialogsAsync(CancellationToken)

Löscht alle vorhandenen Dialogstapel, wodurch alle Dialoge 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 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 Dialoge abgebrochen wurden, nachdem der Turn vom Dialog verarbeitet wurde oder dass der Stapel bereits leer war.

Im Allgemeinen ist der übergeordnete Kontext der Dialog- oder Bot turn-Handler, der den Dialog gestartet hat. Wenn das übergeordnete Dialogfeld ein Dialog ist, ruft der Stapel die -Methode des übergeordneten ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) Elements auf, um ein Ergebnis an den übergeordneten Dialog 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.

Weitere Informationen

Gilt für:

CancelAllDialogsAsync(Boolean, String, Object, CancellationToken)

Löscht alle vorhandenen Dialogstapel, wodurch alle Dialoge 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 der Abbruch auch über alle übergeordneten Dialoge angezeigt.

eventName
String

Das Ereignis.

eventValue
Object

Der Ereigniswert.

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 Dialoge abgebrochen wurden, nachdem der Turn vom Dialog verarbeitet wurde oder dass der Stapel bereits leer war.

Im Allgemeinen ist der übergeordnete Kontext der Dialog- oder Bot turn-Handler, der den Dialog gestartet hat. Wenn das übergeordnete Dialogfeld ein Dialog ist, ruft der Stapel die -Methode des übergeordneten ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) Elements auf, um ein Ergebnis an den übergeordneten Dialog 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.

Weitere Informationen

Gilt für: