WaterfallDialog Clase

  • Referencia
Paquete:
com.microsoft.bot.dialogs
Artefacto Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class WaterfallDialog
extends Dialog

Cuadro de diálogo optimizado para solicitar a un usuario una serie de preguntas. Las cascadas aceptan una pila de funciones que se ejecutarán en secuencia. Cada paso de cascada puede hacer una pregunta del usuario y la respuesta del usuario se pasará como argumento al siguiente paso de cascada.

Resumen del constructor

Constructor Description
WaterfallDialog(String dialogId, List<WaterfallStep> actions)

Inicializa una nueva instancia de la clase WaterfallDialog.

Resumen del método

Modificador y tipo Método y descripción
WaterfallDialog addStep(WaterfallStep step)

Agrega un nuevo paso a la cascada.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Se llama cuando se inicia el cuadro de diálogo en cascada 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 en cascada 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 getVersion()

Obtiene una cadena única que representa la versión de este cuadro de diálogo.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onStep(WaterfallStepContext stepContext)

Se llama cuando se ejecuta un paso de cascada individual.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Se llama cuando un cuadro de diálogo secundario en cascada completó su turno, devolviendo el control a este diálogo.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> runStep(DialogContext dc, int index, DialogReason reason, Object result)

Excute un paso del cuadro de diálogo en cascada.

Métodos heredados de Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

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

WaterfallDialog

public WaterfallDialog(String dialogId, List actions)

Inicializa una nueva instancia de la clase WaterfallDialog.

Parámetros:

dialogId - Identificador del cuadro de diálogo.
actions - Acciones opcionales que va a definir el autor de la llamada.

Detalles del método

addStep

public WaterfallDialog addStep(WaterfallStep step)

Agrega un nuevo paso a la cascada.

Parámetros:

step - Paso para agregar.

Devoluciones:

Cuadro de diálogo en cascada para llamadas fluidas a AddStep().

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

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

Invalidaciones:

WaterfallDialog.beginDialog(DialogContext dc, Object options)

Parámetros:

dc - El
options - Opcional, información inicial que se va a pasar al cuadro de diálogo.

Devoluciones:

CompletableFuture que representa la operación asincrónica. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Se llama cuando el cuadro de diálogo en cascada es _continued_, donde es el diálogo activo y el usuario responde con una nueva actividad.

Invalidaciones:

WaterfallDialog.continueDialog(DialogContext dc)

Parámetros:

dc - El

Devoluciones:

CompletableFuture que representa la operación asincrónica. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value.

endDialog

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

Se llama cuando finaliza el cuadro de diálogo.

Invalidaciones:

WaterfallDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Parámetros:

turnContext - Contexto para el turno actual de la conversación.
instance - Instancia del cuadro de diálogo actual.
reason - Motivo por el que finaliza el cuadro de diálogo.

Devoluciones:

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

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.

Invalidaciones:

WaterfallDialog.getVersion()

Devoluciones:

La versión cambiará cuando cambie el recuento de pasos (ya que el cuadro de diálogo no tiene forma de evaluar el contenido de los pasos.

onStep

protected CompletableFuture onStep(WaterfallStepContext stepContext)

Se llama cuando se ejecuta un paso de cascada individual.

Parámetros:

stepContext - Contexto del paso de cascada que se va a ejecutar.

Devoluciones:

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

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

Se llama cuando un cuadro de diálogo secundario en cascada completó su turno, devolviendo el control a este diálogo.

Invalidaciones:

WaterfallDialog.resumeDialog(DialogContext dc, DialogReason reason, Object result)

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:

Un CompletableFuture que representa la operación asincrónica.

runStep

protected CompletableFuture runStep(DialogContext dc, int index, DialogReason reason, Object result)

Excute un paso del cuadro de diálogo en cascada.

Parámetros:

dc - El DialogContext para el turno actual de conversación.
index - Índice del paso de cascada actual que se va a ejecutar.
reason - Motivo por el que se está ejecutando el paso de cascada.
result - Resultado devuelto por un cuadro de diálogo llamado en el paso de cascada anterior.

Devoluciones:

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

Se aplica a