EndDialog class

Pacote:

botbuilder-dialogs-adaptive

Comando para encerrar a caixa de diálogo atual, retornando o resultProperty como resultado da caixa de diálogo.

Extends

Dialog<O>

Construtores

EndDialog(any)

Cria uma nova instância EndDialog.

Propriedades

$kind
disabled	Uma expressão opcional que, se for true, desabilitará essa ação.
value	Uma expressão de valor para o resultado a ser retornado ao chamador.

Propriedades herdadas

EndOfTurn	Obtém um resultado de fim de turno padrão.
id
telemetryClient

Métodos

beginDialog(DialogContext, O)	Inicia uma nova caixa de diálogo e a envia por push para a pilha de diálogo.
getConverter(Object)

Métodos herdados

configure(Record<string, unknown>)	Método Fluent para configurar o objeto.
continueDialog(DialogContext)	Quando substituído em uma classe derivada, continua a caixa de diálogo.
endDialog(TurnContext, DialogInstance, DialogReason)	Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.
getVersion()	Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação.
onDialogEvent(DialogContext, DialogEvent)	Chamado quando um evento foi acionado, usando DialogContext.emitEvent(), pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.
repromptDialog(TurnContext, DialogInstance)	Quando substituído em uma classe derivada, rerompõe o usuário para entrada.
resumeDialog(DialogContext, DialogReason, any)	Quando substituído em uma classe derivada, retoma a caixa de diálogo após a caixa de diálogo acima dela na pilha ser concluída.

Detalhes do construtor

EndDialog(any)

Cria uma nova instância EndDialog.

new EndDialog(value?: any)

Parâmetros

value

any

Opcional, uma expressão de valor para o resultado a ser retornado ao chamador.

Detalhes da propriedade

$kind

static $kind: string

Valor da propriedade

string

disabled

Uma expressão opcional que, se for true, desabilitará essa ação.

disabled?: BoolExpression

Valor da propriedade

BoolExpression

value

Uma expressão de valor para o resultado a ser retornado ao chamador.

value: ValueExpression

Valor da propriedade

ValueExpression

Detalhes das propriedades herdadas

EndOfTurn

Obtém um resultado de fim de turno padrão.

static EndOfTurn: DialogTurnResult

Valor da propriedade

DialogTurnResult

Comentários

Esse resultado indica que uma caixa de diálogo (ou uma etapa lógica dentro de uma caixa de diálogo) concluiu o processamento para a curva atual, ainda está ativa e está aguardando mais entrada.

Herdado de Dialog.EndOfTurn

id

id: string

Valor da propriedade

string

Herdado de Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Valor da propriedade

BotTelemetryClient

Herdado de Dialog.telemetryClient

Detalhes do método

beginDialog(DialogContext, O)

Inicia uma nova caixa de diálogo e a envia por push para a pilha de diálogo.

function beginDialog(dc: DialogContext, _options?: O): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

O DialogContext para a virada de conversa atual.

_options

O

Opcional. Informações iniciais a serem passadas para a caixa de diálogo.

Retornos

Promise<DialogTurnResult>

Um Promise representando a operação assíncrona.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parâmetros

property

Object

A chave da configuração do seletor condicional.

Retornos

Converter | ConverterFactory

O conversor para a configuração do seletor.

Detalhes do método herdado

configure(Record<string, unknown>)

Método Fluent para configurar o objeto.

function configure(config: Record<string, unknown>): this

Parâmetros

config

Record<string, unknown>

Configurações a serem aplicadas.

Retornos

this

O Configurável após a conclusão da operação.

Herdado de Configurble.configure

continueDialog(DialogContext)

Quando substituído em uma classe derivada, continua a caixa de diálogo.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

O contexto para a ativação da caixa de diálogo atual.

Retornos

Promise<DialogTurnResult>

Uma promessa de resolução para o resultado da curva da caixa de diálogo.

Comentários

Caixas de diálogo derivadas que dão suporte a conversas de várias voltas devem substituir esse método. Por padrão, esse método sinaliza que a caixa de diálogo está concluída e retorna.

O DialogContext chama esse método quando continua a caixa de diálogo.

Para sinalizar para o contexto da caixa de diálogo que essa caixa de diálogo foi concluída, aguarde DialogContext.endDialog antes de sair desse método.

Consulte também

• DialogContext.continueDialog

Herdado de Dialog.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Parâmetros

_context

TurnContext

O objeto de contexto para a curva.

_instance

DialogInstance

Informações de estado atuais para essa caixa de diálogo.

_reason

DialogReason

O motivo pelo qual a caixa de diálogo está terminando.

Retornos

Promise<void>

Comentários

Caixas de diálogo derivadas que precisam executar registro em log ou limpeza antes de terminar devem substituir esse método. Por padrão, esse método não tem efeito.

O DialogContext chama esse método quando a caixa de diálogo atual está terminando.

Consulte também

• DialogContext.cancelAllDialogs
• DialogContext.endDialog
• DialogContext.replaceDialog

Herdado de Dialog.endDialog

getVersion()

Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação.

function getVersion(): string

Retornos

string

Cadeia de caracteres exclusiva que só deve ser alterada quando a caixa de diálogo é alterada de uma maneira que deve reiniciar a caixa de diálogo.

Comentários

Esse padrão é retornar a ID das caixas de diálogo, mas pode ser substituído para fornecer uma lógica de detecção de alterações mais precisa. Qualquer caixa de diálogo na pilha que tenha sua alteração de versão resultará em um versionChanged evento que será gerado. Se esse evento não for tratado pelo bot, um erro será gerado, resultando na execução da lógica do manipulador de erros de bots.

Retornar uma cadeia de caracteres vazia desabilitará o acompanhamento de versão do componente juntos.

Herdado de Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Chamado quando um evento foi acionado, usando DialogContext.emitEvent(), pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parâmetros

dc

DialogContext

O contexto da caixa de diálogo para a virada de conversa atual.

e

DialogEvent

O evento que está sendo gerado.

Retornos

Promise<boolean>

True se o evento for tratado pela caixa de diálogo atual e o borbulhamento deve parar.

Herdado de Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Quando substituído em uma classe derivada, rerompõe o usuário para entrada.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parâmetros

_context

TurnContext

O objeto de contexto para a curva.

_instance

DialogInstance

Informações de estado atuais para essa caixa de diálogo.

Retornos

Promise<void>

Comentários

Caixas de diálogo derivadas que dão suporte à validação e à lógica de prompt devem substituir esse método. Por padrão, esse método não tem efeito.

O DialogContext chama esse método quando a caixa de diálogo atual deve solicitar novamente a entrada do usuário. Esse método é implementado para caixas de diálogo de prompt.

Consulte também

• DialogContext.repromptDialog
• Prompt

Herdado de Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Quando substituído em uma classe derivada, retoma a caixa de diálogo após a caixa de diálogo acima dela na pilha ser concluída.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

O contexto para a ativação da caixa de diálogo atual.

reason

DialogReason

O motivo pelo qual a caixa de diálogo está retomando. Normalmente, isso será DialogReason.endCalled

result

any

Opcional. O valor retornado, se houver, da caixa de diálogo que terminou.

Retornos

Promise<DialogTurnResult>

Uma promessa de resolução para o resultado da curva da caixa de diálogo.

Comentários

Caixas de diálogo derivadas que dão suporte a conversas de várias voltas devem substituir esse método. Por padrão, esse método sinaliza que a caixa de diálogo está concluída e retorna.

O DialogContext chama esse método quando retoma a caixa de diálogo. Se a caixa de diálogo anterior na pilha retornar um valor, esse valor estará no result parâmetro .

Para iniciar uma caixa de diálogo filho , use DialogContext.beginDialog ou DialogContext.prompt; no entanto, essa caixa de diálogo não será necessariamente a que iniciou a caixa de diálogo filho. Para sinalizar para o contexto da caixa de diálogo que essa caixa de diálogo foi concluída, aguarde DialogContext.endDialog antes de sair desse método.

Consulte também

• DialogContext.endDialog

Herdado de Dialog.resumeDialog