DialogContext Clase

  • java.lang.Object
    • com.microsoft.bot.dialogs.DialogContext

public class DialogContext

Proporciona contexto para el estado actual de la pila de diálogos.

Resumen del constructor

Constructor Description
DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)

Inicializa una nueva instancia de la clase DialogContext desde el contexto de turno.

DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

Inicializa una nueva instancia de la clase DialogContext desde el contexto de turno.

Resumen del método

Modificador y tipo Método y descripción
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(String dialogId)

Inicia un cuadro de diálogo nuevo e lo inserta en la pila de diálogos.

java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(String dialogId, Object options)

Inicia un cuadro de diálogo nuevo e lo inserta en la pila de diálogos.

java.util.concurrent.CompletableFuture<DialogTurnResult> cancelAllDialogs()

Método auxiliar para cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) que no cancela los diálogos primarios ni el paso y el evento.

java.util.concurrent.CompletableFuture<DialogTurnResult> cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)

Elimina cualquier pila de diálogos existente, lo que cancela todos los diálogos de la pila.

java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog()

Continúa la ejecución del cuadro de diálogo activo, si hay uno, pasando el cuadro de diálogo actualContexto al método de continueDialog(DialogContext dc) del diálogo activo.

java.util.concurrent.CompletableFuture<java.lang.Boolean> emitEvent(String name)
java.util.concurrent.CompletableFuture<java.lang.Boolean> emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)
java.util.concurrent.CompletableFuture<DialogTurnResult> endDialog()

Método auxiliar que proporciona un resultado NULL para endDialog(Object result).

java.util.concurrent.CompletableFuture<DialogTurnResult> endDialog(Object result)

Finaliza un cuadro de diálogo desmontándolo de la pila y devuelve un resultado opcional al elemento primario del diálogo.

Dialog findDialog(String dialogId)

Busque el identificador del cuadro de diálogo para el contexto especificado.

DialogInstance getActiveDialog()

Obtiene la instancia almacenada en caché del cuadro de diálogo activo en la parte superior de la pila o null si la pila está vacía.

DialogContext getChild()

Obtiene el contexto de diálogo del elemento secundario si hay un elemento secundario activo.

TurnContext getContext()

Obtiene el contexto del turno actual de conversación.

DialogSet getDialogs()

Obtiene el conjunto de diálogos que están activos para el contenedor de diálogos actual.

java.lang.String getLocale()

Obtenga la configuración regional del cuadro de diálogocontexto.

DialogContext getParent()

Obtiene el cuadro de diálogo primarioContexto, si existe.

TurnContextStateCollection getServices()

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

java.util.List<DialogInstance> getStack()

Obtiene la pila de diálogos actual.

DialogStateManager getState()

Obtiene o establece el cuadro de diálogoStateManager que administra la vista de todos los ámbitos de memoria.

java.util.concurrent.CompletableFuture<DialogTurnResult> prompt(String dialogId, PromptOptions options)

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

java.util.concurrent.CompletableFuture<DialogTurnResult> replaceDialog(String dialogId)

Método auxiliar para replaceDialog(String dialogId, Object options) que pasa null para las opciones.

java.util.concurrent.CompletableFuture<DialogTurnResult> replaceDialog(String dialogId, Object options)

Inicia un cuadro de diálogo nuevo y reemplaza en la pila el diálogo activo actualmente por el nuevo.

java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog()

Llama al método repromptDialog(TurnContext turnContext, DialogInstance instance) del cuadro de diálogo activo actualmente.

void setParent(DialogContext withDialogContext)

Establezca el cuadro de diálogo primarioContexto.

Métodos heredados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalles del constructor

DialogContext

public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)

Inicializa una nueva instancia de la clase DialogContext desde el contexto de turno.

Parámetros:

withDialogs - El conjunto de diálogos para el que se va a crear el contexto del diálogo.
withTurnContext - Contexto de turno actual.
withState - Propiedad state de la que se va a recuperar el contexto del cuadro de diálogo.

DialogContext

public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

Inicializa una nueva instancia de la clase DialogContext desde el contexto de turno.

Parámetros:

withDialogs - El conjunto de diálogos para el que se va a crear el contexto del diálogo.
withParentDialogContext - Contexto del cuadro de diálogo primario.
withState - Estado actual del cuadro de diálogo.

Detalles del método

beginDialog

public CompletableFuture beginDialog(String dialogId)

Inicia un cuadro de diálogo nuevo e lo inserta en la pila de diálogos.

Parámetros:

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

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica si el cuadro de diálogo sigue activo después de que el diálogo haya procesado el turno.

beginDialog

public CompletableFuture beginDialog(String dialogId, Object options)

Inicia un cuadro de diálogo nuevo e lo inserta en la pila de diálogos.

Parámetros:

dialogId - Identificador del cuadro de diálogo que se va a iniciar.
options - Opcional, información para pasar al cuadro de diálogo que se está iniciando.

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica si el cuadro de diálogo sigue activo después de que el diálogo haya procesado el turno.

cancelAllDialogs

public CompletableFuture cancelAllDialogs()

Método auxiliar para cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) que no cancela los diálogos primarios ni el paso y el evento.

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica que los diálogos se cancelaron después de procesar el turno mediante el diálogo o que la pila ya estaba vacía.

cancelAllDialogs

public CompletableFuture cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)

Elimina cualquier pila de diálogos existente, lo que cancela todos los diálogos de la pila.

En general, el contexto primario es el cuadro de diálogo o el controlador de turnos de bot que inició el diálogo. Si el elemento primario es un cuadro de diálogo, la pila llama al método resumeDialog(DialogContext dc, DialogReason reason, Object result) primario para devolver un resultado al cuadro de diálogo primario. Si el cuadro de diálogo primario no implementa Dialog#resumeDialog, el elemento primario finalizará también y el resultado se pasará al siguiente contexto primario.

Parámetros:

cancelParents - Si es true, la cancelación también se propagará a través de los diálogos primarios.
eventName - Evento . Si es null, se usa CANCEL_DIALOG.
eventValue - Valor del evento. Puede ser NULL.

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica que los diálogos se cancelaron después de procesar el turno mediante el diálogo o que la pila ya estaba vacía.

continueDialog

public CompletableFuture continueDialog()

Continúa la ejecución del cuadro de diálogo activo, si hay uno, pasando el dialogContext actual al método continueDialog(DialogContext dc) del diálogo activo.

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica si el cuadro de diálogo sigue activo después de que el diálogo haya procesado el turno.

emitEvent

public CompletableFuture emitEvent(String name)

Parámetros:

name - Nombre del evento que se va a generar.

Devoluciones:

emitEvent

emitEvent

public CompletableFuture emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)

Parámetros:

name - Nombre del evento que se va a generar.
value - Valor que se va a enviar junto con el evento .
bubble - Marca para controlar si el evento debe propagarse a su elemento primario si no se controla localmente. El valor predeterminado es true.
fromLeaf - Indica si el evento se emite desde un nodo hoja.

Devoluciones:

completedFuture

endDialog

public CompletableFuture endDialog()

Método auxiliar que proporciona un resultado NULL para endDialog(Object result).

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica que el cuadro de diálogo finalizó después de que el diálogo procesara el turno.

endDialog

public CompletableFuture endDialog(Object result)

Finaliza un cuadro de diálogo desmontándolo de la pila y devuelve un resultado opcional al elemento primario del diálogo. El cuadro de diálogo primario es el diálogo en el que se inició al finalizar a través de una llamada a beginDialog(String dialogId, Object options) o prompt(String dialogId, PromptOptions options). El cuadro de diálogo primario tendrá su método resumeDialog(DialogContext dc, DialogReason reason, Object result) invocado con cualquier resultado devuelto. Si el cuadro de diálogo primario no ha implementado un método resumeDialog(DialogContext dc, DialogReason reason), se finalizará automáticamente y el resultado se pasará a su elemento primario. Si no hay más diálogos primarios en la pila, el procesamiento del turno finalizará.

Parámetros:

result - Opcional, resultado para pasar al contexto primario.

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica que el cuadro de diálogo finalizó después de que el diálogo procesara el turno.

findDialog

public Dialog findDialog(String dialogId)

Busque el identificador del cuadro de diálogo para el contexto especificado.

Parámetros:

dialogId - id. de cuadro de diálogo que se va a buscar.

Devoluciones:

cuadro de diálogo con ese identificador o null.

getActiveDialog

public DialogInstance getActiveDialog()

Obtiene la instancia almacenada en caché del cuadro de diálogo activo en la parte superior de la pila o null si la pila está vacía.

Devoluciones:

Instancia almacenada en caché del cuadro de diálogo activo en la parte superior de la pila o null si la pila está vacía.

getChild

public DialogContext getChild()

Obtiene el contexto de diálogo del elemento secundario si hay un elemento secundario activo.

Devoluciones:

Contexto de cuadro de diálogo para elemento secundario si hay un elemento secundario activo.

getContext

public TurnContext getContext()

Obtiene el contexto del turno actual de conversación.

Devoluciones:

Contexto del turno actual de conversación.

getDialogs

public DialogSet getDialogs()

Obtiene el conjunto de diálogos que están activos para el contenedor de diálogos actual.

Devoluciones:

Conjunto de diálogos que están activos para el contenedor de diálogos actual.

getLocale

public String getLocale()

Obtenga la configuración regional en DialogContext.

Devoluciones:

Cadena que representa la configuración regional actual.

getParent

public DialogContext getParent()

Obtiene el dialogContext primario, si existe. Se usa al buscar el identificador de un cuadro de diálogo que se va a iniciar.

Devoluciones:

El elemento primario "DialogContext, si existe. Se usa al buscar el identificador de un cuadro de diálogo que se va a iniciar.

getServices

public TurnContextStateCollection getServices()

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

Devoluciones:

Colección de servicios.

getStack

public List getStack()

Obtiene la pila de diálogos actual.

Devoluciones:

Pila de diálogos actual.

getState

public DialogStateManager getState()

Obtiene o establece dialogStateManager que administra la vista de todos los ámbitos de memoria.

Devoluciones:

DialogStateManager con vista de memoria unificada de todos los ámbitos de memoria.

prompt

public CompletableFuture prompt(String dialogId, PromptOptions options)

Función auxiliar para simplificar el formato de las opciones para llamar a un cuadro de diálogo de aviso. Este asistente tomará un argumento PromptOptions y, a continuación, llamará a beginDialog(String dialogId, Object options)

Parámetros:

dialogId - Id. del cuadro de diálogo del símbolo del sistema que se va a iniciar.
options - Información que se va a pasar al cuadro de diálogo de solicitud que se está iniciando.

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica si el cuadro de diálogo sigue activo después de que el diálogo haya procesado el turno.

replaceDialog

public CompletableFuture replaceDialog(String dialogId)

Método auxiliar para replaceDialog(String dialogId, Object options) que pasa null para las opciones.

Parámetros:

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

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica si el cuadro de diálogo sigue activo después de que el diálogo haya procesado el turno.

replaceDialog

public CompletableFuture replaceDialog(String dialogId, Object options)

Inicia un cuadro de diálogo nuevo y reemplaza en la pila el diálogo activo actualmente por el nuevo. Esto resulta especialmente útil para crear bucles o redirigir a otro cuadro de diálogo.

Parámetros:

dialogId - Identificador del nuevo cuadro de diálogo que se va a iniciar.
options - Opcional, información para pasar al cuadro de diálogo que se está iniciando.

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica si el cuadro de diálogo sigue activo después de que el diálogo haya procesado el turno.

repromptDialog

public CompletableFuture repromptDialog()

Llama al método repromptDialog(TurnContext turnContext, DialogInstance instance) del cuadro de diálogo activo actualmente. Se usa con diálogos que implementan un comportamiento de nueva solicitud.

Devoluciones:

Tarea que representa el trabajo en cola que se va a ejecutar.

setParent

public void setParent(DialogContext withDialogContext)

Establezca dialogContext primario.

Parámetros:

withDialogContext - DialogContext para establecer el elemento primario en.

Se aplica a