DialogContext Clase
- java.
lang. Object - com.
microsoft. bot. dialogs. DialogContext
- com.
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 Dialog |
| DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState) |
Inicializa una nueva instancia de la clase Dialog |
Resumen del método
| Modificador y tipo | Método y descripción |
|---|---|
|
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(String dialogId)
Inicia un cuadro de diálogo nuevo e lo inserta en la pila de diálogos. |
|
java.util.concurrent.CompletableFuture<Dialog |
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<Dialog |
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<Dialog |
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<Dialog |
continueDialog()
Continúa la ejecución del cuadro de diálogo activo, si hay uno, pasando el cuadro de diálogo actual |
| 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<Dialog |
endDialog()
Método auxiliar que proporciona un resultado NULL para endDialog(Object result). |
|
java.util.concurrent.CompletableFuture<Dialog |
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. |
|
Dialog |
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. |
|
Dialog |
getChild()
Obtiene el contexto de diálogo del elemento secundario si hay un elemento secundario activo. |
|
Turn |
getContext()
Obtiene el contexto del turno actual de conversación. |
|
Dialog |
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álogo |
|
Dialog |
getParent()
Obtiene el cuadro de diálogo primario |
|
Turn |
getServices()
Obtiene la colección de servicios que es contextual para este contexto de diálogo. |
|
java.util.List<Dialog |
getStack()
Obtiene la pila de diálogos actual. |
|
Dialog |
getState()
Obtiene o establece el cuadro de diálogo |
|
java.util.concurrent.CompletableFuture<Dialog |
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<Dialog |
replaceDialog(String dialogId)
Método auxiliar para replaceDialog(String dialogId, Object options) que pasa null para las opciones. |
|
java.util.concurrent.CompletableFuture<Dialog |
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 primario |
Métodos heredados de java.lang.Object
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:
DialogContext
public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)
Inicializa una nueva instancia de la clase DialogContext desde el contexto de turno.
Parámetros:
Detalles del método
beginDialog
public CompletableFuture
Inicia un cuadro de diálogo nuevo e lo inserta en la pila de diálogos.
Parámetros:
Devoluciones:
beginDialog
public CompletableFuture
Inicia un cuadro de diálogo nuevo e lo inserta en la pila de diálogos.
Parámetros:
Devoluciones:
cancelAllDialogs
public CompletableFuture
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:
cancelAllDialogs
public CompletableFuture
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:
Devoluciones:
continueDialog
public CompletableFuture
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:
emitEvent
public CompletableFuture
Parámetros:
Devoluciones:
emitEvent
public CompletableFuture
Parámetros:
true.
Devoluciones:
endDialog
public CompletableFuture
Método auxiliar que proporciona un resultado NULL para endDialog(Object result).
Devoluciones:
endDialog
public CompletableFuture
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:
Devoluciones:
findDialog
public Dialog findDialog(String dialogId)
Busque el identificador del cuadro de diálogo para el contexto especificado.
Parámetros:
Devoluciones:
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:
getChild
public DialogContext getChild()
Obtiene el contexto de diálogo del elemento secundario si hay un elemento secundario activo.
Devoluciones:
getContext
public TurnContext getContext()
Obtiene el contexto del turno actual de conversación.
Devoluciones:
getDialogs
public DialogSet getDialogs()
Obtiene el conjunto de diálogos que están activos para el contenedor de diálogos actual.
Devoluciones:
getLocale
public String getLocale()
Obtenga la configuración regional en DialogContext.
Devoluciones:
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:
getServices
public TurnContextStateCollection getServices()
Obtiene la colección de servicios que es contextual para este contexto de diálogo.
Devoluciones:
getStack
public List
Obtiene la pila de diálogos actual.
Devoluciones:
getState
public DialogStateManager getState()
Obtiene o establece dialogStateManager que administra la vista de todos los ámbitos de memoria.
Devoluciones:
prompt
public CompletableFuture
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:
Devoluciones:
replaceDialog
public CompletableFuture
Método auxiliar para replaceDialog(String dialogId, Object options) que pasa null para las opciones.
Parámetros:
Devoluciones:
replaceDialog
public CompletableFuture
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:
Devoluciones:
repromptDialog
public CompletableFuture
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:
setParent
public void setParent(DialogContext withDialogContext)
Establezca dialogContext primario.
Parámetros: