Dialog class

Pacote:

botbuilder-dialogs

Define o comportamento principal de todos os diálogos.

Extends

Configurable

Construtores

Dialog(string)

Cria uma nova instância da classe da caixa de diálogo .

Propriedades

EndOfTurn	Obtém um resultado de fim de turno padrão.
id	ID exclusiva da caixa de diálogo. Define a ID exclusiva da caixa de diálogo.
telemetryClient	Obtém o cliente de telemetria para esta caixa de diálogo. Define o cliente de telemetria para essa caixa de diálogo.

Métodos

beginDialog(DialogContext, O)	Quando substituído em uma classe derivada, inicia a caixa de diálogo.
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 gerado, 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, reprompta 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.

Métodos herdados

configure(Record<string, unknown>)	Método fluente para configurar o objeto.
getConverter(string)

Detalhes do construtor

Dialog(string)

Cria uma nova instância da classe da caixa de diálogo .

new Dialog(dialogId?: string)

Parâmetros

dialogId

string

Opcional. ID exclusiva da caixa de diálogo.

Detalhes da propriedade

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 em uma caixa de diálogo) concluiu o processamento para a curva atual, ainda está ativa e está aguardando mais entrada.

id

ID exclusiva da caixa de diálogo. Define a ID exclusiva da caixa de diálogo.

string id

Valor da propriedade

string

A ID da caixa de diálogo.

Comentários

Isso será gerado automaticamente se não for especificado.

telemetryClient

Obtém o cliente de telemetria para esta caixa de diálogo. Define o cliente de telemetria para essa caixa de diálogo.

BotTelemetryClient telemetryClient

Valor da propriedade

BotTelemetryClient

O BotTelemetryClient a ser usado para registro em log.

Detalhes do método

beginDialog(DialogContext, O)

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

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

Parâmetros

dc

DialogContext

O contexto da curva de diálogo atual.

options

O

Opcional. Argumentos a serem usados quando a caixa de diálogo for iniciada.

Retornos

Promise<DialogTurnResult>

Comentários

As caixas de diálogo derivadas devem substituir esse método.

O dialogContext chama esse método quando cria um novo dialogInstance para essa caixa de diálogo, envia-o por push para a pilha de diálogo e inicia a caixa de diálogo.

Uma caixa de diálogo que representa uma conversa de turno único deve aguardar dialogContext.endDialog antes de sair desse método.

Consulte também

• DialogContext.beginDialog
• DialogContext.replaceDialog

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 da curva 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 ele 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

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

As caixas de diálogo derivadas que precisam executar o registro em log ou a 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

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 foi alterada de uma maneira que deve reiniciar a caixa de diálogo.

Comentários

Esse padrão é retornar as caixas de diálogo id 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 evento versionChanged 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 para o componente.

onDialogEvent(DialogContext, DialogEvent)

Chamado quando um evento foi gerado, 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 atual da conversa.

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.

repromptDialog(TurnContext, DialogInstance)

Quando substituído em uma classe derivada, reprompta 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 nova solicitação 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

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 da curva de diálogo atual.

reason

DialogReason

O motivo pelo qual a caixa de diálogo está sendo retomada. 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 ele retoma a caixa de diálogo. Se a caixa de diálogo anterior na pilha retornar um valor, esse valor estará no parâmetro result.

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

Detalhes do método herdado

configure(Record<string, unknown>)

Método fluente 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 deConfigurble.configure

getConverter(string)

function getConverter(_property: string): Converter | ConverterFactory

Parâmetros

_property

string

A chave da configuração do seletor condicional.

Retornos

Converter | ConverterFactory

O conversor para a configuração do seletor.

herdado deconfigurable.getConverter