Compartilhar via


DialogContext.EndDialogAsync(Object, CancellationToken) Método

Definição

Encerra uma caixa de diálogo tirando-a da pilha e retornando um resultado opcional para o pai da caixa de diálogo. A caixa de diálogo pai é a caixa de diálogo em que o iniciado está sendo encerrado por meio de uma chamada para BeginDialogAsync(String, Object, CancellationToken) ou PromptAsync(String, PromptOptions, CancellationToken). A caixa de diálogo pai terá seu ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) método invocado com qualquer resultado retornado. Se a caixa de diálogo pai não tiver implementado um ResumeDialogAsync método, ele também será encerrado automaticamente e o resultado será passado para seu pai. Se não houver mais caixas de diálogo pai 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 a ser passado para o contexto pai.

cancellationToken
CancellationToken

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

Retornos

Uma tarefa que representa o trabalho enfileirado para execução.

Comentários

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

Em geral, o contexto pai é o manipulador de diálogo ou de turno do bot que iniciou a caixa de diálogo. Se o pai for uma caixa de diálogo, a pilha chamará o método pai ResumeDialogAsync(DialogContext, DialogReason, Object, CancellationToken) para retornar um resultado para a caixa de diálogo pai. Se a caixa de diálogo pai não implementar 'ResumeDialogAsync', o pai também terminará e o resultado será passado para o próximo contexto pai.

O retornado DialogTurnResult contém o valor retornado em sua Result propriedade.

Aplica-se a

Confira também