Partilhar via


DialogContext.EndDialogAsync(Object, CancellationToken) Método

Definição

Termina uma caixa de diálogo ao tirá-la da pilha e devolve um resultado opcional ao elemento principal da caixa de diálogo. A caixa de diálogo principal é a caixa de diálogo em que começou a terminar através de uma chamada para ou BeginDialogAsync(String, Object, CancellationToken)PromptAsync(String, PromptOptions, CancellationToken). A caixa de diálogo principal terá o método ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) invocado com qualquer resultado devolvido. Se a caixa de diálogo principal não tiver implementado um ResumeDialogAsync método, este também será automaticamente terminado e o resultado será transmitido para o respetivo principal. Se não existirem mais caixas de diálogo principais na pilha, o processamento da curva terminará.

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 passar para o contexto principal.

cancellationToken
CancellationToken

Um token de cancelamento que pode ser utilizado por outros objetos ou threads para receber aviso de cancelamento.

Devoluções

Uma tarefa que representa o trabalho em fila de trabalho a executar.

Observações

Se a tarefa for bem-sucedida, o resultado indica que a caixa de diálogo terminou depois de a curva ter sido processada pela caixa de diálogo.

Em geral, o contexto principal é a caixa de diálogo ou o processador de viragem do bot que iniciou a caixa de diálogo. Se o elemento principal for uma caixa de diálogo, a pilha chama o método principal ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) para devolver um resultado à caixa de diálogo principal. Se a caixa de diálogo principal não implementar "ResumeDialogAsync", o principal também terminará e o resultado será transmitido para o contexto principal seguinte.

O devolvido DialogTurnResult contém o valor devolvido na respetiva Result propriedade.

Aplica-se a

Ver também