DialogContext.EndDialogAsync(Object, CancellationToken) Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Finaliza un diálogo quitándolo de la pila y devuelve un resultado opcional al elemento primario del diálogo. El cuadro de diálogo primario es el cuadro de diálogo en el que se inició al finalizar a través de una llamada a BeginDialogAsync(String, Object, CancellationToken) o PromptAsync(String, PromptOptions, CancellationToken). El cuadro de diálogo primario tendrá su ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) método invocado con cualquier resultado devuelto. Si el cuadro de diálogo primario no ha implementado un ResumeDialogAsync
método, se finalizará automáticamente y el resultado se pasará a su elemento primario.
Si no hay más diálogos primarios en la pila, el procesamiento del turno finalizará.
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)
Parámetros
- result
- Object
Opcional, resultado para pasar al contexto primario.
- cancellationToken
- CancellationToken
Token de cancelación que pueden usar otros objetos o subprocesos para recibir el aviso de cancelación.
Devoluciones
Tarea que representa el trabajo en cola que se va a ejecutar.
Comentarios
Si la tarea se realiza correctamente, el resultado indica que el diálogo finalizó después del turno procesado por el diálogo.
En general, el contexto primario es el cuadro de diálogo o el controlador de turnos de bot que inició el diálogo. Si el elemento primario es un cuadro de diálogo, la pila llama al método del ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) elemento primario para devolver un resultado al diálogo primario. Si el cuadro de diálogo primario no implementa "ResumeDialogAsync", el elemento primario finalizará también y el resultado pasado al siguiente contexto primario.
El devuelto DialogTurnResult contiene el valor devuelto en su Result propiedad .