Dialog class

Paquete:

botbuilder-dialogs

Define el comportamiento principal de todos los diálogos.

Extends

Configurable

Constructores

Dialog(string)

Crea una nueva instancia de la clase dialog Dialog.

Propiedades

EndOfTurn	Obtiene un resultado predeterminado de fin de turno.
id	Identificador único del cuadro de diálogo. Establece el identificador único del cuadro de diálogo.
telemetryClient	Obtiene el cliente de telemetría para este cuadro de diálogo. Establece el cliente de telemetría para este cuadro de diálogo.

Métodos

beginDialog(DialogContext, O)	Cuando se invalida en una clase derivada, inicia el cuadro de diálogo.
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.
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)	Cuando se invalida en una clase derivada, reanuda el cuadro de diálogo después de que se complete el cuadro de diálogo encima de ella en la pila.

Métodos heredados

configure(Record<string, unknown>)	Método Fluent para configurar el objeto.
getConverter(string)

Detalles del constructor

Dialog(string)

Crea una nueva instancia de la clase dialog Dialog.

new Dialog(dialogId?: string)

Parámetros

dialogId

string

Opcional. identificador único del cuadro de diálogo.

Detalles de las propiedades

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.

id

Identificador único del cuadro de diálogo. Establece el identificador único del cuadro de diálogo.

string id

Valor de propiedad

string

Identificador del cuadro de diálogo.

Comentarios

Se generará automáticamente si no se especifica.

telemetryClient

Obtiene el cliente de telemetría para este cuadro de diálogo. Establece el cliente de telemetría para este cuadro de diálogo.

BotTelemetryClient telemetryClient

Valor de propiedad

BotTelemetryClient

BotTelemetryClient que se va a usar para el registro.

Detalles del método

beginDialog(DialogContext, O)

Cuando se invalida en una clase derivada, inicia el cuadro de diálogo.

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

Parámetros

dc

DialogContext

Contexto del turno del cuadro de diálogo actual.

options

O

Opcional. Argumentos que se usarán cuando se inicie el cuadro de diálogo.

Devoluciones

Promise<DialogTurnResult>

Comentarios

Los diálogos derivados deben invalidar este método.

El DialogContext llama a este método cuando crea un nuevo dialogInstance para este cuadro de diálogo, lo inserta en la pila de diálogos e inicia el diálogo.

Un cuadro de diálogo que representa una conversación de un solo turno debe esperar dialogContext.endDialog antes de salir de este método.

Consulte también

• dialogContext.beginDialog
• dialogContext.replaceDialog

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.

Consulte también

• dialogContext.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.

Consulte también

• DialogContext.cancelAllDialogs
• dialogContext.endDialog
• dialogContext.replaceDialog

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.

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.

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.

Consulte también

• dialogContext.repromptDialog
• prompt

resumeDialog(DialogContext, DialogReason, any)

Cuando se invalida en una clase derivada, reanuda el cuadro de diálogo después de que se complete el cuadro de diálogo encima de ella en la pila.

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

Parámetros

dc

DialogContext

Contexto del turno del cuadro de diálogo actual.

reason

DialogReason

La razón por la que se reanuda el cuadro de diálogo. Normalmente, se dialogReason.endCalled

result

any

Opcional. Valor devuelto, si existe, del cuadro de diálogo que finalizó.

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 reanuda el cuadro de diálogo. Si el cuadro de diálogo anterior de la pila devolvió un valor, ese valor se encuentra en el parámetro result.

Para iniciar un cuadro de diálogo de secundario de , use DialogContext.beginDialog o DialogContext.prompt; sin embargo, este diálogo no será necesariamente el que inició el diálogo secundario. Para indicar al contexto de diálogo que ha completado este diálogo, espere dialogContext.endDialog antes de salir de este método.

Consulte también

• dialogContext.endDialog

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 deconfigurable.configure

getConverter(string)

function getConverter(_property: string): Converter | ConverterFactory

Parámetros

_property

string

Clave de la configuración del selector condicional.

Devoluciones

Converter | ConverterFactory

Convertidor para la configuración del selector.

heredado deconfigurable.getConverter