AdaptiveDialog class

Pacote:

botbuilder-dialogs-adaptive

A caixa de diálogo adaptável modela a conversa usando eventos e eventos para se adaptar dinamicamente ao fluxo de conversa em mudança.

Extends

DialogContainer<O>

Construtores

AdaptiveDialog(string)

Cria uma nova instância de AdaptiveDialog.

Propriedades

$kind
autoEndDialog	Se a caixa de diálogo deve ser encerrada quando não há ações a serem executadas.
conditionTracker
defaultResultProperty	A propriedade a ser retornada como resultado quando a caixa de diálogo terminar quando não houver mais Ações e AutoEndDialog = true.
generator	Opcional. Substituição do Gerador de Idiomas.
recognizer	Opcional. Reconhecedor usado para analisar quaisquer enunciados de mensagem.
schema	Define o esquema JSON para a caixa de diálogo. Obtém o esquema JSON da caixa de diálogo.
selector	Opcional. O seletor para escolher os eventos possíveis a serem executados.
triggers	Disparar manipuladores para responder às condições que modificam o plano de execução.

Propriedades herdadas

dialogs	O conjunto de diálogos de contêineres.
EndOfTurn	Obtém um resultado de fim de turno padrão.
id
telemetryClient

Métodos

beginDialog(DialogContext, O)	Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo.
continueDialog(DialogContext)	Chamado quando a caixa de diálogo é continuada, em que é a caixa de diálogo ativa e o usuário responde com uma nova atividade.
createChildContext(DialogContext)	Cria um dialogContext filho para o contexto fornecido.
endDialog(TurnContext, DialogInstance, DialogReason)	Chamado quando a caixa de diálogo está terminando.
getConverter(Object)
getDependencies()	Obtém caixa de diálogo dependências enumeradas.
repromptDialog(DialogContext | TurnContext, DialogInstance)	Reprompta o usuário.
resumeDialog(DialogContext, DialogReason, any)	Chamado quando uma caixa de diálogo filho concluiu sua vez, retornando o controle para essa caixa de diálogo.

Métodos herdados

configure(Record<string, unknown>)	Método fluente para configurar o objeto.
findDialog(string)	Localiza uma caixa de diálogo filho que foi adicionada anteriormente ao contêiner.
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.

Detalhes do construtor

AdaptiveDialog(string)

Cria uma nova instância de AdaptiveDialog.

new AdaptiveDialog(dialogId?: string)

Parâmetros

dialogId

string

(Opcional) ID exclusiva do componente dentro do conjunto de diálogos de seus pais.

Detalhes da propriedade

$kind

static $kind: string

Valor da propriedade

string

autoEndDialog

Se a caixa de diálogo deve ser encerrada quando não há ações a serem executadas.

autoEndDialog: BoolExpression

Valor da propriedade

BoolExpression

Comentários

Se for true, quando não houver ações a serem executadas, a caixa de diálogo atual terminará. Se for false, quando não houver ações a serem executadas, a caixa de diálogo atual simplesmente encerrará a curva e ainda estará ativa. O padrão é um valor verdadeiro.

conditionTracker

static conditionTracker: string

Valor da propriedade

string

defaultResultProperty

A propriedade a ser retornada como resultado quando a caixa de diálogo terminar quando não houver mais Ações e AutoEndDialog = true.

defaultResultProperty: string

Valor da propriedade

string

Comentários

O padrão é um valor de dialog.result.

generator

Opcional. Substituição do Gerador de Idiomas.

generator?: LanguageGenerator

Valor da propriedade

LanguageGenerator

recognizer

Opcional. Reconhecedor usado para analisar quaisquer enunciados de mensagem.

recognizer?: Recognizer

Valor da propriedade

Recognizer

schema

Define o esquema JSON para a caixa de diálogo. Obtém o esquema JSON da caixa de diálogo.

object schema

Valor da propriedade

object

O esquema da caixa de diálogo.

selector

Opcional. O seletor para escolher os eventos possíveis a serem executados.

selector: TriggerSelector

Valor da propriedade

TriggerSelector

triggers

Disparar manipuladores para responder às condições que modificam o plano de execução.

triggers: OnCondition[]

Valor da propriedade

OnCondition[]

Detalhes das propriedades herdadas

dialogs

O conjunto de diálogos de contêineres.

dialogs: DialogSet

Valor da propriedade

DialogSet

herdado de dialogContainer.dialogs

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.

herdado de dialog.EndOfTurn

id

id: string

Valor da propriedade

string

herdado de Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Valor da propriedade

BotTelemetryClient

Herdado de DialogContainer.telemetryClient

Detalhes do método

beginDialog(DialogContext, O)

Chamado quando a caixa de diálogo é iniciada e enviada 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 atual da conversa.

options

O

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

Retornos

Promise<DialogTurnResult>

Uma promessa que representa a operação assíncrona.

continueDialog(DialogContext)

Chamado quando a caixa de diálogo é continuada, em que é a caixa de diálogo ativa e o usuário responde com uma nova atividade.

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

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

Retornos

Promise<DialogTurnResult>

Uma promessa que representa a operação assíncrona.

createChildContext(DialogContext)

Cria um dialogContext filho para o contexto fornecido.

function createChildContext(dc: DialogContext): DialogContext

Parâmetros

dc

DialogContext

O dialogContext para a virada atual da conversa.

Retornos

DialogContext

O dialogContext filho ou nulo se nenhuma AdaptiveDialogState.actions for encontrada para o contexto fornecido.

endDialog(TurnContext, DialogInstance, DialogReason)

Chamado quando a caixa de diálogo está terminando.

function endDialog(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Parâmetros

turnContext

TurnContext

O objeto de contexto para este turno.

instance

DialogInstance

Informações de estado associadas à instância dessa caixa de diálogo na pilha de diálogo.

reason

DialogReason

Motivo pelo qual a caixa de diálogo terminou.

Retornos

Promise<void>

Uma promessa que representa 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.

getDependencies()

Obtém caixa de diálogo dependências enumeradas.

function getDependencies(): Dialog[]

Retornos

Dialog[]

(xref:botbuilder-dialogs. As dependências enumeradas da caixa de diálogo.

repromptDialog(DialogContext | TurnContext, DialogInstance)

Reprompta o usuário.

function repromptDialog(context: DialogContext | TurnContext, instance: DialogInstance): Promise<void>

Parâmetros

context

DialogContext | TurnContext

O objeto de contexto para a curva.

instance

DialogInstance

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

Retornos

Promise<void>

Uma promessa que representa a operação assíncrona.

resumeDialog(DialogContext, DialogReason, any)

Chamado quando uma caixa de diálogo filho concluiu sua vez, retornando o controle para essa caixa de diálogo.

function resumeDialog(dc: DialogContext, _reason?: DialogReason, _result?: any): Promise<DialogTurnResult>

Parâmetros

dc

DialogContext

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

_reason

DialogReason

Motivo pelo qual a caixa de diálogo foi retomada.

_result

any

Opcional, o valor retornado da caixa de diálogo que foi chamada. O tipo do valor retornado depende da caixa de diálogo filho.

Retornos

Promise<DialogTurnResult>

Uma promessa que representa a operação assíncrona.

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 de Configurble.configure

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.

Herdado de DialogContainer.findDialog

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 de Dialog.getVersion

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.

Herdado de DialogContainer.onDialogEvent