DialogContainer class
Um contêiner para um conjunto de caixas de diálogo.
- Extends
-
Dialog<O>
Construtores
Dialog |
Cria uma nova instância da classe da caixa de diálogo |
Propriedades
dialogs | O conjunto de diálogos de contêineres. |
id | ID exclusiva da caixa de diálogo. Define a ID exclusiva da caixa de diálogo. |
telemetry |
Defina o cliente de telemetria e aplique-o a todas as caixas de diálogo filho. As caixas de diálogo futuras adicionadas ao componente também herdarão esse cliente. Obtenha o cliente de telemetria atual. |
Propriedades herdadas
End |
Obtém um resultado de fim de turno padrão. |
Métodos
create |
Cria um contexto de diálogo interno para o filho ativo dos contêineres. |
find |
Localiza uma caixa de diálogo filho que foi adicionada anteriormente ao contêiner. |
on |
Chamado quando um evento foi gerado, usando |
Métodos herdados
begin |
Quando substituído em uma classe derivada, inicia a caixa de diálogo. |
configure(Record<string, unknown>) | Método fluente para configurar o objeto. |
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 |
|
get |
Uma cadeia de caracteres codificada usada para ajudar na detecção de alterações de bot na re-implantação. |
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. |
Detalhes do construtor
DialogContainer(string)
Cria uma nova instância da classe da caixa de diálogo
new DialogContainer(dialogId?: string)
Parâmetros
- dialogId
-
string
Opcional. ID exclusiva da caixa de diálogo.
Detalhes da propriedade
dialogs
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
Defina o cliente de telemetria e aplique-o a todas as caixas de diálogo filho. As caixas de diálogo futuras adicionadas ao componente também herdarão esse cliente. Obtenha o cliente de telemetria atual.
BotTelemetryClient telemetryClient
Valor da propriedade
BotTelemetryClient
O
Detalhes das propriedades herdadas
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.
Detalhes do método
createChildContext(DialogContext)
Cria um contexto de diálogo interno para o filho ativo dos contêineres.
function createChildContext(dc: DialogContext): DialogContext | undefined
Parâmetros
Contexto da caixa de diálogo dos pais.
Retornos
DialogContext | undefined
Um novo contexto de caixa de diálogo para o filho ativo ou undefined
se não houver nenhum filho ativo.
findDialog(string)
Localiza uma caixa de diálogo filho que foi adicionada anteriormente ao contêiner.
function findDialog(dialogId: string): Dialog | undefined
Parâmetros
- dialogId
-
string
ID da caixa de diálogo a ser pesquisada.
Retornos
Dialog | undefined
A caixa de diálogo, se encontrada; caso contrário, nulo.
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.
Detalhes do método herdado
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
Herdado doDialog.beginDialog
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
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
Herdado doDialog.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
Consulte também
- DialogContext.cancelAllDialogs
- dialogContext.endDialog
-
DialogContext.replaceDialog
herdado dedialog.endDialog
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
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.
herdado dedialog.getVersion
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
Herdado deDialog.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
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
Herdado deDialog.resumeDialog