DialogContext.CancelAllDialogsAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| 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
キャンセル通知を受け取るために他のオブジェクトまたはスレッドで使用できるキャンセル トークン。
戻り値
実行するキューに登録された作業を表すタスク。
注釈
タスクが成功した場合、結果は、ダイアログによってターンが処理された後にダイアログが取り消されたか、スタックが既に空であることを示します。
一般に、親コンテキストは、ダイアログを開始したダイアログまたはボット ターン ハンドラーです。 親がダイアログの場合、スタックは親の 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
キャンセル通知を受け取るために他のオブジェクトまたはスレッドで使用できるキャンセル トークン。
戻り値
実行するキューに登録された作業を表すタスク。
注釈
タスクが成功した場合、結果は、ダイアログによってターンが処理された後にダイアログが取り消されたか、スタックが既に空であることを示します。
一般に、親コンテキストは、ダイアログを開始したダイアログまたはボット ターン ハンドラーです。 親がダイアログの場合、スタックは親の ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) メソッドを呼び出して、結果を親ダイアログに返します。 親ダイアログに 'ResumeDialogAsync' が実装されていない場合、親も終了し、結果は次の親コンテキストに渡されます。