DialogContext.CancelAllDialogsAsync 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
多載
| 名稱 | Description |
|---|---|
| CancelAllDialogsAsync(CancellationToken) |
刪除任何現有的對話堆疊,因此會取消堆疊上的所有對話方塊。 |
| CancelAllDialogsAsync(Boolean, String, Object, CancellationToken) |
刪除任何現有的對話堆疊,因此會取消堆疊上的所有對話方塊。 |
CancelAllDialogsAsync(CancellationToken)
刪除任何現有的對話堆疊,因此會取消堆疊上的所有對話方塊。
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)
參數
- cancellationToken
- CancellationToken
一種可被其他物件或執行緒用來接收取消通知的取消標記。
傳回
工作,表示要執行的工作佇列。
備註
如果工作成功,結果表示對話在回合處理后已取消對話,或堆疊已是空的。
一般而言,父內容是啟動對話框的對話框或 Bot 回合處理程式。 如果父代是對話框,堆疊會呼叫父系的 ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) 方法,將結果傳回父對話。 若父對話框未實作「ResumeDialogAsync」,則父對話框也會結束,結果會傳遞至下一個父上下文。
另請參閱
適用於
CancelAllDialogsAsync(Boolean, String, Object, CancellationToken)
刪除任何現有的對話堆疊,因此會取消堆疊上的所有對話方塊。
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)
參數
- cancelParents
- Boolean
如果為 true,取消也會透過任何父對話框反升。
- eventName
- String
事件。
- eventValue
- Object
事件值。
- cancellationToken
- CancellationToken
一種可被其他物件或執行緒用來接收取消通知的取消標記。
傳回
工作,表示要執行的工作佇列。
備註
如果工作成功,結果表示對話在回合處理后已取消對話,或堆疊已是空的。
一般而言,父內容是啟動對話框的對話框或 Bot 回合處理程式。 如果父代是對話框,堆疊會呼叫父系的 ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) 方法,將結果傳回父對話。 若父對話框未實作「ResumeDialogAsync」,則父對話框也會結束,結果會傳遞至下一個父上下文。