Dialog Clase
- java.
lang. Object - com.
microsoft. bot. dialogs. Dialog
- com.
public abstract class Dialog
Clase base para todos los diálogos.
Resumen del campo
| Modificador y tipo | Campo y descripción |
|---|---|
|
static final
Dialog |
END_OF_TURN
Un DialogTurnResult que indica que el cuadro de diálogo actual sigue activo y esperando la entrada del siguiente turno del usuario. |
Resumen del constructor
| Constructor | Description |
|---|---|
| Dialog(String dialogId) |
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(DialogContext dc)
Se llama cuando se inicia el cuadro de diálogo y se inserta en la pila de diálogos. |
|
abstract
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(DialogContext dc, Object options)
Se llama cuando se inicia el cuadro de diálogo y se inserta en la pila de diálogos. |
|
java.util.concurrent.CompletableFuture<Dialog |
continueDialog(DialogContext dc)
Se llama cuando el cuadro de diálogo es _continued_, donde es el diálogo activo y el usuario responde con una nueva actividad. |
| java.util.concurrent.CompletableFuture<java.lang.Void> |
endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)
Se llama cuando finaliza el cuadro de diálogo. |
| java.lang.String |
getId()
Obtiene el identificador del cuadro de diálogo. |
|
Bot |
getTelemetryClient()
Obtiene el BotTelemetryClient que se va a usar para el registro. |
| java.lang.String |
getVersion()
Obtiene una cadena única que representa la versión de este cuadro de diálogo. |
|
protected static
java.util.concurrent.CompletableFuture<Dialog |
innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)
Implementación compartida de la ejecución con Dialog y Dialog |
| protected java.lang.String |
onComputeId()
Calcula un identificador para el cuadro de diálogo. |
| java.util.concurrent.CompletableFuture<java.lang.Boolean> |
onDialogEvent(DialogContext dc, DialogEvent e)
Se llama cuando se genera un evento mediante "Dialog |
| protected java.util.concurrent.CompletableFuture<java.lang.Boolean> |
onPostBubbleEvent(DialogContext dc, DialogEvent e)
Se llamó después de que un evento se propagase a todos los padres y no se manejó. |
| protected java.util.concurrent.CompletableFuture<java.lang.Boolean> |
onPreBubbleEvent(DialogContext dc, DialogEvent e)
Se llama antes de que se propaga un evento a su elemento primario. |
| java.util.concurrent.CompletableFuture<java.lang.Void> |
repromptDialog(TurnContext turnContext, DialogInstance instance)
Se llama cuando el cuadro de diálogo debe volver a solicitar al usuario la entrada. |
|
java.util.concurrent.CompletableFuture<Dialog |
resumeDialog(DialogContext dc, DialogReason reason)
Se llama cuando un cuadro de diálogo secundario completó este turno, devolviendo el control a este diálogo. |
|
java.util.concurrent.CompletableFuture<Dialog |
resumeDialog(DialogContext dc, DialogReason reason, Object result)
Se llama cuando un cuadro de diálogo secundario completó este turno, devolviendo el control a este diálogo. |
| static java.util.concurrent.CompletableFuture<java.lang.Void> |
run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor<DialogState> accessor)
Crea una pila de diálogos e inicia un diálogo, lo inserta en la pila. |
| void |
setId(String withId)
Establece id para el cuadro de diálogo. |
| void |
setTelemetryClient(BotTelemetryClient withTelemetryClient)
Establece el BotTelemetryClient que se va a usar para el registro. |
Métodos heredados de java.lang.Object
Detalles del campo
END_OF_TURN
public static final DialogTurnResult END_OF_TURN
Un DialogTurnResult que indica que el cuadro de diálogo actual sigue activo y esperando la entrada del siguiente turno del usuario.
Detalles del constructor
Dialog
public Dialog(String dialogId)
Inicializa una nueva instancia de la clase Dialog.
Parámetros:
Detalles del método
beginDialog
public CompletableFuture
Se llama cuando se inicia el cuadro de diálogo y se inserta en la pila de diálogos.
Parámetros:
Devoluciones:
beginDialog
public abstract CompletableFuture
Se llama cuando se inicia el cuadro de diálogo y se inserta en la pila de diálogos.
Parámetros:
Devoluciones:
continueDialog
public CompletableFuture
Se llama cuando el cuadro de diálogo es _continued_, donde es el diálogo activo y el usuario responde con una nueva actividad.
Si este método es *no* reemplazado, el cuadro de diálogo finaliza automáticamente cuando el usuario responde.
Parámetros:
Devoluciones:
endDialog
public CompletableFuture
Se llama cuando finaliza el cuadro de diálogo.
Parámetros:
Devoluciones:
getId
public String getId()
Obtiene el identificador del cuadro de diálogo.
Devoluciones:
getTelemetryClient
public BotTelemetryClient getTelemetryClient()
Obtiene el BotTelemetryClient que se va a usar para el registro.
Devoluciones:
getVersion
public String getVersion()
Obtiene una cadena única que representa la versión de este cuadro de diálogo. Si la versión cambia entre turnos, el sistema de diálogo emitirá un evento DialogChanged.
Devoluciones:
innerRun
protected static CompletableFuture
Implementación compartida de la ejecución con Dialog y DialogManager.
Parámetros:
Devoluciones:
onComputeId
protected String onComputeId()
Calcula un identificador para el cuadro de diálogo.
Devoluciones:
onDialogEvent
public CompletableFuture
Se llama cuando se genera un evento mediante "DialogContext.emitEvent()", ya sea mediante el diálogo actual o un diálogo que inició el diálogo actual.
Parámetros:
Devoluciones:
onPostBubbleEvent
protected CompletableFuture
Se llamó después de que un evento se propagase a todos los padres y no se manejó.
Este es un buen lugar para realizar la lógica de procesamiento predeterminada para un evento. Devolver "true" impedirá cualquier procesamiento del evento por cuadros de diálogo secundarios.
Parámetros:
Devoluciones:
onPreBubbleEvent
protected CompletableFuture
Se llama antes de que se propaga un evento a su elemento primario.
Este es un buen lugar para realizar la interceptación de un evento, ya que devolver "true" impedirá cualquier propagación adicional del evento a los elementos primarios de diálogos y también impedirá que los diálogos secundarios realicen su procesamiento predeterminado.
Parámetros:
Devoluciones:
repromptDialog
public CompletableFuture
Se llama cuando el cuadro de diálogo debe volver a solicitar al usuario la entrada.
Parámetros:
Devoluciones:
resumeDialog
public CompletableFuture
Se llama cuando un cuadro de diálogo secundario completó este turno, devolviendo el control a este diálogo.
Por lo general, el cuadro de diálogo secundario se inició con una llamada a beginDialog(DialogContext dc, Object options) Sin embargo, si se llama al método replaceDialog(String dialogId), el cuadro de diálogo secundario lógico puede ser diferente del original.
Si este método es *no* reemplazado, el cuadro de diálogo finaliza automáticamente cuando el usuario responde.
Parámetros:
Devoluciones:
resumeDialog
public CompletableFuture
Se llama cuando un cuadro de diálogo secundario completó este turno, devolviendo el control a este diálogo.
Por lo general, el cuadro de diálogo secundario se inició con una llamada a beginDialog(DialogContext dc, Object options) Sin embargo, si se llama al método replaceDialog(String dialogId, Object options), el cuadro de diálogo secundario lógico puede ser diferente del original.
Si este método es *no* reemplazado, el cuadro de diálogo finaliza automáticamente cuando el usuario responde.
Parámetros:
Devoluciones:
run
public static CompletableFuture
Crea una pila de diálogos e inicia un diálogo, lo inserta en la pila.
Parámetros:
Devoluciones:
setId
public void setId(String withId)
Establece id para el cuadro de diálogo.
Parámetros:
setTelemetryClient
public void setTelemetryClient(BotTelemetryClient withTelemetryClient)
Establece el BotTelemetryClient que se va a usar para el registro.
Parámetros: