Dialog class
Define o comportamento principal de todos os diálogos.
- Extends
Construtores
Dialog(string) | Cria uma nova instância da classe da caixa de diálogo |
Propriedades
End |
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. |
telemetry |
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
begin |
Quando substituído em uma classe derivada, inicia a caixa de diálogo. |
continue |
Quando substituído em uma classe derivada, continua a caixa de diálogo. |
end |
Quando substituído em uma classe derivada, executa a limpeza da caixa de diálogo antes de terminar. |
get |
Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação. |
on |
Chamado quando um evento foi gerado, usando |
reprompt |
Quando substituído em uma classe derivada, reprompta o usuário para entrada. |
resume |
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. |
get |
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
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
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
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
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
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
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
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
O contexto da caixa de diálogo para a virada atual da conversa.
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
Consulte também
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
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
Consulte também
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
O conversor para a configuração do seletor.
herdado deconfigurable.getConverter