Dialog Clase

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

public abstract class Dialog

Clase base para todos los diálogos.

Resumen del campo

Modificador y tipo Campo y descripción
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.

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<DialogTurnResult> 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<DialogTurnResult> 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<DialogTurnResult> 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.

BotTelemetryClient 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<DialogTurnResult> innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Implementación compartida de la ejecución con Dialog y DialogManager.

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 "DialogContext.emitirEvent()' mediante el cuadro de diálogo actual o un diálogo que inició el diálogo actual.

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<DialogTurnResult> 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<DialogTurnResult> 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

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 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:

dialogId - Identificador que se va a asignar a este cuadro de diálogo.

Detalles del método

beginDialog

public CompletableFuture beginDialog(DialogContext dc)

Se llama cuando se inicia el cuadro de diálogo y se inserta en la pila de diálogos.

Parámetros:

dc - El DialogContext para el turno actual de conversación.

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 abstract CompletableFuture beginDialog(DialogContext dc, Object options)

Se llama cuando se inicia el cuadro de diálogo y se inserta en la pila de diálogos.

Parámetros:

dc - El DialogContext para el turno actual de conversación.
options - Información inicial que se va a pasar al cuadro de diálogo.

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.

continueDialog

public CompletableFuture 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.

Si este método es *no* reemplazado, el cuadro de diálogo finaliza automáticamente cuando el usuario responde.

Parámetros:

dc - El DialogContext para el turno actual de conversación.

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. El resultado también puede contener un valor devuelto.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Se llama cuando finaliza el cuadro de diálogo.

Parámetros:

turnContext - Objeto de contexto para este turno.
instance - Información de estado asociada a la instancia de este cuadro de diálogo en la pila de diálogos.
reason - Motivo por el que finalizó el cuadro de diálogo.

Devoluciones:

CompletableFuture que representa la operación asincrónica.

getId

public String getId()

Obtiene el identificador del cuadro de diálogo.

Devoluciones:

Identificador del cuadro de diálogo.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Obtiene el BotTelemetryClient que se va a usar para el registro.

Devoluciones:

BotTelemetryClient que se va a usar para el registro.

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:

Cadena única que solo debe cambiar cuando el cuadro de diálogo ha cambiado de una manera que debe reiniciar el diálogo.

innerRun

protected static CompletableFuture innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Implementación compartida de la ejecución con Dialog y DialogManager.

Parámetros:

turnContext - TurnContext.
dialogId - Identificador del cuadro de diálogo.
dialogContext - The DialogContext.
stateConfiguration - The DialogStateManagerConfiguration.

Devoluciones:

Un dialogTurnResult.

onComputeId

protected String onComputeId()

Calcula un identificador para el cuadro de diálogo.

Devoluciones:

El identificador.

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

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:

dc - Contexto del cuadro de diálogo para el turno actual de conversación.
e - Evento que se está generando.

Devoluciones:

True si el diálogo actual controla el evento y se debe detener la propagación.

onPostBubbleEvent

protected CompletableFuture onPostBubbleEvent(DialogContext dc, DialogEvent e)

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:

dc - Contexto del cuadro de diálogo para el turno actual de conversación.
e - Evento que se está generando.

Devoluciones:

Si el diálogo actual controla el evento y se debe detener el procesamiento adicional.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

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:

dc - Contexto del cuadro de diálogo para el turno actual de conversación.
e - Evento que se está generando.

Devoluciones:

Si el diálogo actual controla el evento y se debe detener el procesamiento adicional.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Se llama cuando el cuadro de diálogo debe volver a solicitar al usuario la entrada.

Parámetros:

turnContext - Objeto de contexto para este turno.
instance - Información de estado de este cuadro de diálogo.

Devoluciones:

CompletableFuture que representa la operación asincrónica.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason)

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:

dc - Contexto del cuadro de diálogo para el turno actual de la conversación.
reason - Motivo por el que se reanudó el cuadro de diálogo.

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica si este diálogo sigue activo después de procesar este turno de diálogo.

resumeDialog

public CompletableFuture 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.

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:

dc - Contexto del cuadro de diálogo para el turno actual de la conversación.
reason - Motivo por el que se reanudó el cuadro de diálogo.
result - Opcional, el valor devuelto desde el cuadro de diálogo al que se llamó. El tipo del valor devuelto depende del cuadro de diálogo secundario.

Devoluciones:

Si la tarea se realiza correctamente, el resultado indica si este diálogo sigue activo después de procesar este turno de diálogo.

run

public static CompletableFuture run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor accessor)

Crea una pila de diálogos e inicia un diálogo, lo inserta en la pila.

Parámetros:

dialog - Cuadro de diálogo que se va a iniciar.
turnContext - Contexto del turno actual de la conversación.
accessor - Descriptor de acceso StatePropertyAccessor con el que administrar el estado de la pila de diálogos.

Devoluciones:

Tarea que representa la operación asincrónica.

setId

public void setId(String withId)

Establece id para el cuadro de diálogo.

Parámetros:

withId - Identificador del cuadro de diálogo.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Establece el BotTelemetryClient que se va a usar para el registro.

Parámetros:

withTelemetryClient - BotTelemetryClient que se va a usar para el registro.

Se aplica a