Compartir a través de


DynamicBeginDialog class

Acción BeginDialog interna que enlaza dinámicamente x.schema/x.dialog para invocar el recurso x.dialog con propiedades como opciones.

Extends

Constructores

DynamicBeginDialog(string, O)

Crea una nueva instancia de BeginDialog.

Propiedades

$kind

Propiedades heredadas

activityProcessed

Valor que indica si el cuadro de diálogo nuevo debe procesar la actividad.

dialog

Cuadro de diálogo al que se va a llamar.

disabled

Una expresión opcional que, si es true, deshabilitará esta acción.

EndOfTurn

Obtiene un resultado predeterminado de fin de turno.

id
options

Opciones configurables para el cuadro de diálogo.

resultProperty

(Opcional) ruta de acceso de la propiedad para almacenar el resultado del cuadro de diálogo.

telemetryClient

Métodos heredados

beginDialog(DialogContext, O)

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

configure(Record<string, unknown>)

Método Fluent para configurar el objeto.

continueDialog(DialogContext)

Cuando se invalida en una clase derivada, continúa el cuadro de diálogo.

endDialog(TurnContext, DialogInstance, DialogReason)

Cuando se invalida en una clase derivada, realiza la limpieza del cuadro de diálogo antes de que finalice.

getConverter(Object)
getDependencies()

Obtiene el cuadro de diálogo secundario dependencias para que se puedan agregar a los contenedores Cuadro de diálogo establecido.

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.

repromptDialog(TurnContext, DialogInstance)

Cuando se invalida en una clase derivada, reprote el usuario para la entrada.

resumeDialog(DialogContext, DialogReason, any)

Se llama cuando un cuadro de diálogo secundario completó su turno, devolviendo el control a este cuadro de diálogo.

Detalles del constructor

DynamicBeginDialog(string, O)

Crea una nueva instancia de BeginDialog.

new DynamicBeginDialog(dialogIdToCall: string, options?: O)

Parámetros

dialogIdToCall

string

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

options

O

(Opcional) opciones estáticas para pasar el cuadro de diálogo llamado.

Detalles de las propiedades

$kind

static $kind: string

Valor de propiedad

string

Detalles de las propiedades heredadas

activityProcessed

Valor que indica si el cuadro de diálogo nuevo debe procesar la actividad.

activityProcessed: BoolExpression

Valor de propiedad

BoolExpression

Heredado deBaseInvokeDialog.activityProcessed

dialog

Cuadro de diálogo al que se va a llamar.

dialog: DialogExpression

Valor de propiedad

heredado deBaseInvokeDialog.dialog

disabled

Una expresión opcional que, si es true, deshabilitará esta acción.

disabled?: BoolExpression

Valor de propiedad

BoolExpression

heredado deBeginDialog.disabled

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

options

Opciones configurables para el cuadro de diálogo.

options: ObjectExpression<object>

Valor de propiedad

ObjectExpression<object>

Heredado deBaseInvokeDialog.options

resultProperty

(Opcional) ruta de acceso de la propiedad para almacenar el resultado del cuadro de diálogo.

resultProperty?: StringExpression

Valor de propiedad

StringExpression

Heredado deBeginDialog.resultProperty

telemetryClient

telemetryClient: BotTelemetryClient

Valor de propiedad

BotTelemetryClient

Heredado de Dialog.telemetryClient

Detalles de los métodos heredados

beginDialog(DialogContext, O)

Se llama cuando se inicia el cuadro de diálogo de 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>

Un Promise que representa la operación asincrónica.

Heredado deBeginDialog.beginDialog

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

continueDialog(DialogContext)

Cuando se invalida en una clase derivada, continúa el cuadro de diálogo.

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

Parámetros

dc

DialogContext

Contexto del turno del cuadro de diálogo actual.

Devoluciones

Promise<DialogTurnResult>

Promesa que resuelve el resultado del turno del cuadro de diálogo.

Comentarios

Los diálogos derivados que admiten conversaciones de varios turnos deben invalidar este método. De forma predeterminada, este método indica que el cuadro de diálogo está completo y devuelve.

El DialogContext llama a este método cuando continúa el diálogo.

Para indicar al contexto de diálogo que ha completado este diálogo, espere dialogContext.endDialog antes de salir de este método.

Ver también

Heredado de Dialog.continueDialog

endDialog(TurnContext, DialogInstance, DialogReason)

Cuando se invalida en una clase derivada, realiza la limpieza del cuadro de diálogo antes de que finalice.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

Parámetros

_context

TurnContext

Objeto de contexto del turno.

_instance

DialogInstance

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

_reason

DialogReason

Motivo por el que finaliza el cuadro de diálogo.

Devoluciones

Promise<void>

Comentarios

Los diálogos derivados que necesitan realizar el registro o la limpieza antes de finalizar deben invalidar este método. De forma predeterminada, este método no tiene ningún efecto.

El DialogContext llama a este método cuando finaliza el diálogo actual.

Ver también

Heredado de Dialog.endDialog

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.

heredado deBeginDialog.getConverter

getDependencies()

Obtiene el cuadro de diálogo secundario dependencias para que se puedan agregar a los contenedores Cuadro de diálogo establecido.

function getDependencies(): Dialog<__type>[]

Devoluciones

Dialog<__type>[]

Dependencias del cuadro de diálogo de secundario.

heredado debaseInvokeDialog.getDependencies

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 Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Cuando se invalida en una clase derivada, reprote el usuario para la entrada.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parámetros

_context

TurnContext

Objeto de contexto del turno.

_instance

DialogInstance

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

Devoluciones

Promise<void>

Comentarios

Los diálogos derivados que admiten la validación y la lógica de nueva solicitud deben invalidar este método. De forma predeterminada, este método no tiene ningún efecto.

El DialogContext llama a este método cuando el diálogo actual debe volver a solicitar la entrada del usuario. Este método se implementa para los cuadros de diálogo de solicitud.

Ver también

Heredado de Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Se llama cuando un cuadro de diálogo secundario completó su turno, devolviendo el control a este cuadro de diálogo.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Parámetros

dc

DialogContext

dialogContext para el turno actual de conversación.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), motivo por el que se reanudó el diálogo.

result

any

Opcional. 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>

Un Promise que representa la operación asincrónica.

heredado deBeginDialog.resumeDialog