DialogContext class

Paquete:

botbuilder-dialogs

Contexto para el turno de diálogo actual con respecto a un DialogSet específico.

Comentarios

Esto incluye el contexto de turno, la información sobre el conjunto de diálogos y el estado de la pila de diálogos.

Desde código fuera de un cuadro de diálogo del conjunto, use DialogSet.createContext para crear el contexto del diálogo. A continuación, use los métodos del contexto de diálogo para administrar la progresión de los diálogos en el conjunto.

Al implementar un cuadro de diálogo, el contexto del diálogo es un parámetro disponible para los distintos métodos que invalida o implementa.

Por ejemplo:

const dc = await dialogs.createContext(turnContext);
const result = await dc.continueDialog();

Constructores

DialogContext(DialogSet, DialogContext, DialogState)	Crea una nueva instancia de la clase DialogContext .
DialogContext(DialogSet, TurnContext, DialogState)	Crea una nueva instancia de la clase DialogContext .

Propiedades

activeDialog
child
context	Obtiene el objeto de contexto del turno.
dialogManager
dialogs	Obtiene los diálogos a los que se puede llamar directamente desde este contexto.
parent	Contexto de diálogo primario para este contexto de diálogo o undefined si este contexto no tiene un elemento primario.
services	Obtiene la colección de servicios que es contextual a este contexto de diálogo.
stack	Obtiene la pila de diálogos actual.
state	Obtiene el DialogStateManager que administra la vista de todos los ámbitos de memoria.

Métodos

beginDialog(string, object)	Inicia una instancia de diálogo e la inserta en la pila de diálogos. Crea una nueva instancia del cuadro de diálogo y la inserta en la pila.
cancelAllDialogs(boolean, string, any)	Cancela todos los diálogos de la pila de diálogos y borra la pila.
continueDialog()	Continúa la ejecución del cuadro de diálogo activo, si hay alguno, pasando este contexto de diálogo a su método Dialog.continueDialog .
emitEvent(string, any, boolean, boolean)	Busca un cuadro de diálogo con un identificador determinado.
endDialog(any)	Finaliza un cuadro de diálogo y lo quita de la pila. Devuelve un resultado opcional al elemento primario del cuadro de diálogo.
findDialog(string)	Busca un cuadro de diálogo con un identificador determinado.
getLocale()	Obtenga cultureInfo en DialogContext.
prompt(string, string | Partial<Activity> | PromptOptions)	Función auxiliar para simplificar el formato de las opciones para llamar a un cuadro de diálogo de aviso.
prompt(string, string | Partial<Activity> | PromptOptions, string | Choice[])	Función auxiliar para simplificar el formato de las opciones para llamar a un cuadro de diálogo de aviso.
replaceDialog(string, object)	Finaliza el diálogo activo e inicia un diálogo nuevo en su lugar.
repromptDialog()	Solicita al cuadro de diálogo activo que vuelva a solicitar al usuario la entrada.

Detalles del constructor

DialogContext(DialogSet, DialogContext, DialogState)

Crea una nueva instancia de la clase DialogContext .

new DialogContext(dialogs: DialogSet, contextOrDC: DialogContext, state: DialogState)

Parámetros

dialogs

DialogSet

DialogSet para el que se va a crear el contexto del diálogo.

contextOrDC

DialogContext

Objeto TurnContext para el turno actual del bot.

state

DialogState

Objeto de estado que se va a usar para leer y escribir DialogState en el almacenamiento.

Comentarios

Si se pasa una instancia de DialogContext , se clonará el contexto del diálogo.

DialogContext(DialogSet, TurnContext, DialogState)

Crea una nueva instancia de la clase DialogContext .

new DialogContext(dialogs: DialogSet, contextOrDC: TurnContext, state: DialogState)

Parámetros

dialogs

DialogSet

DialogSet para el que se va a crear el contexto del diálogo.

contextOrDC

TurnContext

Objeto TurnContext para el turno actual del bot.

state

DialogState

Objeto de estado que se va a usar para leer y escribir DialogState en el almacenamiento.

Comentarios

Si se pasa una instancia de DialogContext , se clonará el contexto del diálogo.

Detalles de las propiedades

activeDialog

DialogInstance | undefined activeDialog

Valor de propiedad

DialogInstance | undefined

Información de estado del cuadro de diálogo en la parte superior de la pila de diálogos o undefined si la pila está vacía.

child

DialogContext | undefined child

Valor de propiedad

DialogContext | undefined

Contexto de diálogo para elemento secundario si el diálogo activo es un contenedor.

context

Obtiene el objeto de contexto del turno.

context: TurnContext

Valor de propiedad

TurnContext

dialogManager

Advertencia

Esta API ya está en desuso.

This property serves no function.

DialogManager dialogManager

Valor de propiedad

DialogManager

Instancia actual del administrador de diálogos. Esta propiedad está desusada.

dialogs

Obtiene los diálogos a los que se puede llamar directamente desde este contexto.

dialogs: DialogSet

Valor de propiedad

DialogSet

parent

Contexto de diálogo primario para este contexto de diálogo o undefined si este contexto no tiene un elemento primario.

parent: DialogContext | undefined

Valor de propiedad

DialogContext | undefined

Comentarios

Cuando intenta iniciar un diálogo, el contexto del diálogo busca el Dialog.id en sus diálogos. Si el cuadro de diálogo que se va a iniciar no se encuentra en este contexto de diálogo, busca en su contexto de diálogo primario, etc.

services

Obtiene la colección de servicios que es contextual a este contexto de diálogo.

services: TurnContextStateCollection

Valor de propiedad

TurnContextStateCollection

stack

Obtiene la pila de diálogos actual.

stack: DialogInstance[]

Valor de propiedad

DialogInstance[]

state

Obtiene el DialogStateManager que administra la vista de todos los ámbitos de memoria.

state: DialogStateManager

Valor de propiedad

DialogStateManager

Detalles del método

beginDialog(string, object)

Inicia una instancia de diálogo e la inserta en la pila de diálogos. Crea una nueva instancia del cuadro de diálogo y la inserta en la pila.

function beginDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

Parámetros

dialogId

string

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

options

object

Opcional. Argumentos para pasar al cuadro de diálogo cuando se inicia.

Devoluciones

Promise<DialogTurnResult>

una promesa que resuelve el resultado del turno del diálogo.

Comentarios

Si ya hay un diálogo activo en la pila, ese diálogo se pausará hasta que vuelva a ser el diálogo superior de la pila.

El estado del objeto devuelto describe el estado de la pila de diálogos una vez completado este método.

Este método produce una excepción si el cuadro de diálogo solicitado no se encuentra en este contexto de diálogo o en ninguno de sus antecesores.

Por ejemplo:

const result = await dc.beginDialog('greeting', { name: user.name });

Consulte también

• endDialog
• prompt
• replaceDialog
• Dialog.beginDialog

cancelAllDialogs(boolean, string, any)

Cancela todos los diálogos de la pila de diálogos y borra la pila.

function cancelAllDialogs(cancelParents?: boolean, eventName?: string, eventValue?: any): Promise<DialogTurnResult>

Parámetros

cancelParents

boolean

Opcional. Si true también se cancelarán todos los diálogos primarios.

eventName

string

Opcional. El nombre de un evento personalizado que se va a generar como diálogos se cancela. Este valor predeterminado es cancelDialog.

eventValue

any

Opcional. Valor que se va a pasar junto con el evento de cancelación personalizado.

Devoluciones

Promise<DialogTurnResult>

una promesa que resuelve el resultado del turno del diálogo.

Comentarios

Esto llama al método Dialog.endDialog de cada diálogo antes de quitar el diálogo de la pila.

Si hay diálogos en la pila inicialmente, se cancela el estado del valor devuelto; de lo contrario, está vacío.

En este ejemplo se borra una pila de diálogos, dc, antes de iniciar un cuadro de diálogo "bookFlight".

await dc.cancelAllDialogs();
return await dc.beginDialog('bookFlight');

Consulte también

• endDialog

continueDialog()

Continúa la ejecución del cuadro de diálogo activo, si hay alguno, pasando este contexto de diálogo a su método Dialog.continueDialog .

function continueDialog(): Promise<DialogTurnResult>

Devoluciones

Promise<DialogTurnResult>

una promesa que resuelve el resultado del turno del diálogo.

Comentarios

Una vez completada la llamada, puede comprobar la propiedad respondida del contexto de turno para determinar si el cuadro de diálogo envió una respuesta al usuario.

El estado del objeto devuelto describe el estado de la pila de diálogos una vez completado este método.

Normalmente, llamaría a esto desde el controlador de turnos del bot.

Por ejemplo:

const result = await dc.continueDialog();
if (result.status == DialogTurnStatus.empty && dc.context.activity.type == ActivityTypes.message) {
    // Send fallback message
    await dc.context.sendActivity(`I'm sorry. I didn't understand.`);
}

emitEvent(string, any, boolean, boolean)

Busca un cuadro de diálogo con un identificador determinado.

function emitEvent(name: string, value?: any, bubble?: boolean, fromLeaf?: boolean): Promise<boolean>

Parámetros

name

string

nombre del evento que se va a generar.

value

any

Opcional. Valor que se va a enviar junto con el evento .

bubble

boolean

Opcional. Marca para controlar si el evento debe propagarse a su elemento primario si no se controla localmente. El valor truepredeterminado es .

fromLeaf

boolean

Opcional. Si el evento se emite desde un nodo hoja.

Devoluciones

Promise<boolean>

true es si se ha controlado el evento.

Comentarios

Emite un evento con nombre para el cuadro de diálogo actual, o alguien que lo inició, para controlarlo.

endDialog(any)

Finaliza un cuadro de diálogo y lo quita de la pila. Devuelve un resultado opcional al elemento primario del cuadro de diálogo.

function endDialog(result?: any): Promise<DialogTurnResult>

Parámetros

result

any

Opcional. Resultado que se va a pasar a la lógica primaria. Este podría ser el siguiente cuadro de diálogo de la pila, o si este era el último diálogo de la pila, un contexto de diálogo primario o el controlador de turnos del bot.

Devoluciones

Promise<DialogTurnResult>

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

Comentarios

El diálogo primario es el siguiente diálogo de la pila de diálogos, si hay uno. Este método llama al método Dialog.resumeDialog del elemento primario y pasa el resultado devuelto por el cuadro de diálogo final. Si no hay ningún cuadro de diálogo primario, el turno finaliza y el resultado está disponible para el bot a través de la propiedad result del objeto devuelto.

El estado del objeto devuelto describe el estado de la pila de diálogos una vez completado este método.

Normalmente, llamaría a esto desde dentro de la lógica de un diálogo específico para volver a indicar al contexto de diálogo que el diálogo se ha completado, el diálogo debe quitarse de la pila y el diálogo primario debe reanudarse.

Por ejemplo:

return await dc.endDialog(returnValue);

Consulte también

• beginDialog
• replaceDialog
• Dialog.endDialog

findDialog(string)

Busca un cuadro de diálogo con un identificador determinado.

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 para el identificador proporcionado.

Comentarios

Si el cuadro de diálogo que se va a iniciar no se encuentra en el DialogSet asociado a este contexto de diálogo, intenta buscar el diálogo en su contexto de diálogo primario.

Consulte también

• Diálogos
• parent

getLocale()

Obtenga cultureInfo en DialogContext.

function getLocale(): string

Devoluciones

string

una cadena de configuración regional.

prompt(string, string | Partial<Activity> | PromptOptions)

Función auxiliar para simplificar el formato de las opciones para llamar a un cuadro de diálogo de aviso.

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions): Promise<DialogTurnResult>

Parámetros

dialogId

string

Id. del cuadro de diálogo de aviso que se va a iniciar.

promptOrOptions

string | Partial<Activity> | PromptOptions

Texto del símbolo del sistema inicial para enviar al usuario, la actividad que se va a enviar como el símbolo del sistema inicial o el objeto con el que se va a dar formato al cuadro de diálogo de solicitud.

Devoluciones

Promise<DialogTurnResult>

Comentarios

Este método auxiliar da formato al objeto que se va a usar como options parámetro y, a continuación, llama a beginDialog para iniciar el cuadro de diálogo de solicitud especificado.

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

prompt(string, string | Partial<Activity> | PromptOptions, string | Choice[])

Función auxiliar para simplificar el formato de las opciones para llamar a un cuadro de diálogo de aviso.

function prompt(dialogId: string, promptOrOptions: string | Partial<Activity> | PromptOptions, choices: string | Choice[]): Promise<DialogTurnResult>

Parámetros

dialogId

string

Id. del cuadro de diálogo de aviso que se va a iniciar.

promptOrOptions

string | Partial<Activity> | PromptOptions

Texto del símbolo del sistema inicial para enviar al usuario, la actividad que se va a enviar como el símbolo del sistema inicial o el objeto con el que se va a dar formato al cuadro de diálogo de solicitud.

choices

string | Choice[]

Opcional. Matriz de opciones entre las que elegir el usuario, para su uso con choicePrompt.

Devoluciones

Promise<DialogTurnResult>

Comentarios

Este método auxiliar da formato al objeto que se va a usar como options parámetro y, a continuación, llama a beginDialog para iniciar el cuadro de diálogo de solicitud especificado.

return await dc.prompt('confirmPrompt', `Are you sure you'd like to quit?`);

replaceDialog(string, object)

Finaliza el diálogo activo e inicia un diálogo nuevo en su lugar.

function replaceDialog(dialogId: string, options?: object): Promise<DialogTurnResult>

Parámetros

dialogId

string

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

options

object

Opcional. Argumentos para pasar al nuevo cuadro de diálogo cuando se inicia.

Devoluciones

Promise<DialogTurnResult>

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

Comentarios

Esto es especialmente útil para crear un bucle o redirigir a otro cuadro de diálogo.

El estado del objeto devuelto describe el estado de la pila de diálogos una vez completado este método.

Este método es similar a finalizar el cuadro de diálogo actual e iniciar inmediatamente el nuevo. Sin embargo, el cuadro de diálogo primario no se reanuda ni se notifica de otro modo.

Consulte también

• beginDialog
• endDialog

repromptDialog()

Solicita al cuadro de diálogo activo que vuelva a solicitar al usuario la entrada.

function repromptDialog(): Promise<void>

Devoluciones

Promise<void>

Comentarios

Esto llama al método repromptDialog del cuadro de diálogo activo.

Por ejemplo:

await dc.repromptDialog();