AdaptiveDialog class

Paquete:

botbuilder-dialogs-adaptive

El cuadro de diálogo adaptable modela la conversación mediante eventos y eventos para adaptarse dinámicamente al flujo de conversación cambiante.

Extends

DialogContainer<O>

Constructores

AdaptiveDialog(string)

Crea una nueva instancia de AdaptiveDialog.

Propiedades

$kind
autoEndDialog	Si finaliza el cuadro de diálogo cuando no hay ninguna acción que ejecutar.
conditionTracker
defaultResultProperty	Propiedad que se va a devolver como resultado cuando el cuadro de diálogo finaliza cuando no hay más acciones y AutoEndDialog = true.
generator	Opcional. Invalidación del generador de lenguaje.
recognizer	Opcional. Recognizer se usa para analizar las expresiones de mensaje.
schema	Establece el esquema JSON para el cuadro de diálogo. Obtiene el esquema JSON para el cuadro de diálogo.
selector	Opcional. Selector para seleccionar los posibles eventos que se van a ejecutar.
triggers	Desencadene controladores para responder a las condiciones que modifican el plan en ejecución.

Propiedades heredadas

dialogs	El conjunto de diálogos contenedores.
EndOfTurn	Obtiene un resultado predeterminado de fin de turno.
id
telemetryClient

Métodos

beginDialog(DialogContext, O)	Se llama cuando se inicia el cuadro de diálogo y se inserta en la pila de diálogos.
continueDialog(DialogContext)	Se llama cuando se continúa el cuadro de diálogo, donde es el diálogo activo y el usuario responde con una nueva actividad.
createChildContext(DialogContext)	Crea un dialogContext secundario para el contexto especificado.
endDialog(TurnContext, DialogInstance, DialogReason)	Se llama cuando finaliza el cuadro de diálogo.
getConverter(Object)
getDependencies()	Obtiene Cuadro de diálogo dependencias enumeradas.
repromptDialog(DialogContext | TurnContext, DialogInstance)	Reprompts el usuario.
resumeDialog(DialogContext, DialogReason, any)	Se llama cuando un cuadro de diálogo secundario ha completado su turno y devuelve el control a este diálogo.

Métodos heredados

configure(Record<string, unknown>)	Método Fluent para configurar el objeto.
findDialog(string)	Busca un cuadro de diálogo secundario que se agregó anteriormente al contenedor.
getVersion()	Cadena codificada que se usa para ayudar a detectar los cambios del bot en la reimplempleción.
onDialogEvent(DialogContext, DialogEvent)	Se llama cuando se ha generado un evento, mediante DialogContext.emitEvent(), mediante el cuadro de diálogo actual o un diálogo que inició el diálogo actual.

Detalles del constructor

AdaptiveDialog(string)

Crea una nueva instancia de AdaptiveDialog.

new AdaptiveDialog(dialogId?: string)

Parámetros

dialogId

string

(Opcional) identificador único del componente dentro de su conjunto de diálogos primarios.

Detalles de las propiedades

$kind

static $kind: string

Valor de propiedad

string

autoEndDialog

Si finaliza el cuadro de diálogo cuando no hay ninguna acción que ejecutar.

autoEndDialog: BoolExpression

Valor de propiedad

BoolExpression

Comentarios

Si es true, cuando no hay ninguna acción que ejecutar, el cuadro de diálogo actual finalizará. Si es false, cuando no hay ninguna acción que ejecutar, el cuadro de diálogo actual simplemente finalizará el turno y seguirá estando activo. El valor predeterminado es true.

conditionTracker

static conditionTracker: string

Valor de propiedad

string

defaultResultProperty

Propiedad que se va a devolver como resultado cuando el cuadro de diálogo finaliza cuando no hay más acciones y AutoEndDialog = true.

defaultResultProperty: string

Valor de propiedad

string

Comentarios

El valor predeterminado es dialog.result.

generator

Opcional. Invalidación del generador de lenguaje.

generator?: LanguageGenerator

Valor de propiedad

LanguageGenerator

recognizer

Opcional. Recognizer se usa para analizar las expresiones de mensaje.

recognizer?: Recognizer

Valor de propiedad

Recognizer

schema

Establece el esquema JSON para el cuadro de diálogo. Obtiene el esquema JSON para el cuadro de diálogo.

object schema

Valor de propiedad

object

Esquema de diálogo.

selector

Opcional. Selector para seleccionar los posibles eventos que se van a ejecutar.

selector: TriggerSelector

Valor de propiedad

TriggerSelector

triggers

Desencadene controladores para responder a las condiciones que modifican el plan en ejecución.

triggers: OnCondition[]

Valor de propiedad

OnCondition[]

Detalles de las propiedades heredadas

dialogs

El conjunto de diálogos contenedores.

dialogs: DialogSet

Valor de propiedad

DialogSet

Heredado de DialogContainer.dialogs

EndOfTurn

Obtiene un resultado predeterminado de fin de turno.

static EndOfTurn: DialogTurnResult

Valor de propiedad

DialogTurnResult

Comentarios

Este resultado indica que un cuadro de diálogo (o un paso lógico dentro de un diálogo) ha completado el procesamiento del turno actual, sigue activo y está esperando más entradas.

heredado de dialog.EndOfTurn

id

id: string

Valor de propiedad

string

heredado de Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Valor de propiedad

BotTelemetryClient

Heredado de DialogContainer.telemetryClient

Detalles del método

beginDialog(DialogContext, O)

Se llama cuando se inicia el cuadro de diálogo y se inserta en la pila de diálogos.

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

Parámetros

dc

DialogContext

dialogContext para el turno actual de conversación.

options

O

Opcional, información inicial que se va a pasar al cuadro de diálogo.

Devoluciones

Promise<DialogTurnResult>

Promesa que representa la operación asincrónica.

continueDialog(DialogContext)

Se llama cuando se continúa el cuadro de diálogo, donde es el diálogo activo y el usuario responde con una nueva actividad.

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

Parámetros

dc

DialogContext

dialogContext para el turno actual de conversación.

Devoluciones

Promise<DialogTurnResult>

Promesa que representa la operación asincrónica.

createChildContext(DialogContext)

Crea un dialogContext secundario para el contexto especificado.

function createChildContext(dc: DialogContext): DialogContext

Parámetros

dc

DialogContext

dialogContext para el turno actual de conversación.

Devoluciones

DialogContext

El secundario DialogContext o null si no se encuentra ningún AdaptiveDialogState.actions para el contexto especificado.

endDialog(TurnContext, DialogInstance, DialogReason)

Se llama cuando finaliza el cuadro de diálogo.

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

Parámetros

turnContext

TurnContext

Objeto de contexto para este turno.

instance

DialogInstance

Información de estado asociada a la instancia de este cuadro de diálogo en la pila de diálogos.

reason

DialogReason

Motivo por el que finalizó el cuadro de diálogo.

Devoluciones

Promise<void>

Promesa que representa la operación asincrónica.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parámetros

property

Object

Clave de la configuración del selector condicional.

Devoluciones

Converter | ConverterFactory

Convertidor para la configuración del selector.

getDependencies()

Obtiene Cuadro de diálogo dependencias enumeradas.

function getDependencies(): Dialog[]

Devoluciones

Dialog[]

(xref:botbuilder-dialogs. Dialog)'s dependencias enumeradas.

repromptDialog(DialogContext | TurnContext, DialogInstance)

Reprompts el usuario.

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

Parámetros

context

DialogContext | TurnContext

Objeto de contexto del turno.

instance

DialogInstance

Información de estado actual para este cuadro de diálogo.

Devoluciones

Promise<void>

Promesa que representa la operación asincrónica.

resumeDialog(DialogContext, DialogReason, any)

Se llama cuando un cuadro de diálogo secundario ha completado su turno y devuelve el control a este diálogo.

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

Parámetros

dc

DialogContext

Contexto del cuadro de diálogo para el turno actual de la conversación.

_reason

DialogReason

Motivo por el que se reanudó el cuadro de diálogo.

_result

any

Opcional, el valor devuelto desde el cuadro de diálogo al que se llamó. El tipo del valor devuelto depende del cuadro de diálogo secundario.

Devoluciones

Promise<DialogTurnResult>

Promesa que representa la operación asincrónica.

Detalles de los métodos heredados

configure(Record<string, unknown>)

Método Fluent para configurar el objeto.

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

Parámetros

config

Record<string, unknown>

Opciones de configuración que se van a aplicar.

Devoluciones

this

configurable una vez completada la operación.

Heredado de Configurable.configure

findDialog(string)

Busca un cuadro de diálogo secundario que se agregó anteriormente al contenedor.

function findDialog(dialogId: string): Dialog | undefined

Parámetros

dialogId

string

Identificador del cuadro de diálogo que se va a buscar.

Devoluciones

Dialog | undefined

Cuadro de diálogo si se encuentra; de lo contrario, null.

Heredado de DialogContainer.findDialog

getVersion()

Cadena codificada que se usa para ayudar a detectar los cambios del bot en la reimplempleción.

function getVersion(): string

Devoluciones

string

Cadena única que solo debe cambiar cuando el cuadro de diálogo ha cambiado de una manera que debe reiniciar el diálogo.

Comentarios

Este valor predeterminado es devolver los cuadros de diálogo id, pero se puede invalidar para proporcionar lógica de detección de cambios más precisa. Cualquier cuadro de diálogo de la pila que tenga su cambio de versión producirá un evento versionChanged. Si el bot no controla este evento, se producirá un error que dará lugar a la ejecución de la lógica del controlador de errores de bots.

Al devolver una cadena vacía, se deshabilitará el seguimiento de versiones para el componente en conjunto.

Heredado de Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Se llama cuando se ha generado un evento, mediante DialogContext.emitEvent(), mediante el cuadro de diálogo actual o un diálogo que inició el diálogo actual.

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

Parámetros

dc

DialogContext

Contexto del cuadro de diálogo para el turno actual de conversación.

e

DialogEvent

Evento que se está generando.

Devoluciones

Promise<boolean>

True si el diálogo actual controla el evento y se debe detener la propagación.

Heredado de DialogContainer.onDialogEvent