DialogContext.EndDialogAsync(Object, CancellationToken) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
スタックからダイアログをポップしてダイアログを終了し、オプションの結果をダイアログの親に返します。 親ダイアログは、 または PromptAsync(String, PromptOptions, CancellationToken)の呼び出しBeginDialogAsync(String, Object, CancellationToken)によって終了するで開始された ダイアログです。 親ダイアログには、 ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) 返された結果でメソッドが呼び出されます。 親ダイアログにメソッドが実装 ResumeDialogAsync されていない場合は、自動的に終了し、結果もその親に渡されます。
スタック上にそれ以上の親ダイアログがない場合、ターンの処理は終了します。
public System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult> EndDialogAsync (object result = default, System.Threading.CancellationToken cancellationToken = default);member this.EndDialogAsync : obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Builder.Dialogs.DialogTurnResult>Public Function EndDialogAsync (Optional result As Object = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DialogTurnResult)パラメーター
- result
- Object
省略可能。結果は親コンテキストに渡されます。
- cancellationToken
- CancellationToken
キャンセル通知を受け取るために他のオブジェクトまたはスレッドで使用できるキャンセル トークン。
戻り値
実行するキューに登録された作業を表すタスク。
注釈
タスクが成功した場合、結果は、ダイアログによってターンが処理された後にダイアログが終了したことを示します。
一般に、親コンテキストは、ダイアログを開始したダイアログまたはボット ターン ハンドラーです。 親がダイアログの場合、スタックは親の ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) メソッドを呼び出して、結果を親ダイアログに返します。 親ダイアログに 'ResumeDialogAsync' が実装されていない場合、親も終了し、結果は次の親コンテキストに渡されます。
返される DialogTurnResult には、そのプロパティの戻り値が Result 含まれています。