Prompt<T> Clase

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

Parámetros de tipo

T

Escriba el mensaje para el que se crea.

public abstract class Prompt
extends Dialog

Define el comportamiento principal de los diálogos de solicitud. Cuando finaliza el mensaje, debe devolver un objeto que representa el valor que se le ha pedido. Use add(Dialog dialog) o addDialog(Dialog dialog) para agregar un mensaje a un conjunto de diálogos o a un cuadro de diálogo de componentes, respectivamente. Use prompt(String dialogId, PromptOptions options) o beginDialog(String dialogId, Object options) para iniciar el símbolo del sistema. Si inicia un mensaje desde un WaterfallStep en un WaterfallDialog, el resultado del mensaje estará disponible en el siguiente paso de la cascada.

Resumen del campo

Modificador y tipo Campo y descripción
static final java.lang.String ATTEMPTCOUNTKEY

Resumen del constructor

Constructor Description
Prompt(String dialogId, PromptValidator<T> validator)

Inicializa una nueva instancia de la clase {@link Prompt{T}} .

Resumen del método

Modificador y tipo Método y descripción
protected Activity appendChoices(Activity prompt, String channelId, List<Choice> choices, ListStyle style, ChoiceFactoryOptions options)

Cuando se invalida en una clase derivada, anexa opciones a la actividad cuando se solicita al usuario la entrada.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Se llama cuando se inserta un cuadro de diálogo de solicitud en la pila de diálogos y se activa.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Se llama cuando un cuadro de diálogo de solicitud es el diálogo activo y el usuario respondió con una nueva actividad.
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.
protected abstract java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Cuando se invalida en una clase derivada, solicita al usuario la entrada.
protected abstract java.util.concurrent.CompletableFuture<PromptRecognizerResult<T>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Cuando se invalida en una clase derivada, intenta reconocer la entrada del usuario.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Se llama cuando se ha solicitado un cuadro de diálogo de solicitud para volver a solicitar al usuario la entrada.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Se llama cuando un cuadro de diálogo de solicitud se reanuda como el diálogo activo en la pila de diálogos, como cuando se completa el diálogo activo anterior en la pila.

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 campo

ATTEMPTCOUNTKEY

public static final String ATTEMPTCOUNTKEY

Detalles del constructor

Prompt

public Prompt(String dialogId, PromptValidator validator)

Inicializa una nueva instancia de la clase {@link Prompt{T}} . Se llama desde constructores de clases derivadas para inicializar la clase {@link Prompt{T}}} .

Parámetros:

dialogId - Identificador que se va a asignar a este símbolo del sistema.
validator - Opcional, una {@link PromptValidator{T}} que contiene validación personalizada adicional para este mensaje. 
              The value of dialogId must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.bot.dialogs.DialogSet"></xref> or
              <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.bot.dialogs.ComponentDialog"></xref> to which
              the prompt is added.

Detalles del método

appendChoices

protected Activity appendChoices(Activity prompt, String channelId, List choices, ListStyle style, ChoiceFactoryOptions options)

Cuando se invalida en una clase derivada, anexa opciones a la actividad cuando se solicita al usuario la entrada.

Parámetros:

prompt - Actividad a la que se anexan las opciones.
channelId - Identificador del canal del usuario.
choices - Opciones que se van a anexar.
style - Indica cómo se deben presentar las opciones al usuario.
options - Las opciones de formato que se usarán al presentar las opciones.

Devoluciones:

Un CompletableFuture que representa la operación asincrónica. 
     If the task is successful, the result contains the updated activity.

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Se llama cuando se inserta un cuadro de diálogo de solicitud en la pila de diálogos y se activa.

Invalidaciones:

Prompt<T>.beginDialog(DialogContext dc, Object options)

Parámetros:

dc - Contexto del cuadro de diálogo para el turno actual de la conversación.
options - Opcional, información adicional para pasar al símbolo del sistema que se está iniciando.

Devoluciones:

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

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Se llama cuando un cuadro de diálogo de solicitud es el diálogo activo y el usuario respondió con una nueva actividad.

Invalidaciones:

Prompt<T>.continueDialog(DialogContext dc)

Parámetros:

dc - Contexto del cuadro de diálogo para el turno actual de conversación.

Devoluciones:

Un 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
     prompt generally continues to receive the user's replies until it
     accepts the user's reply as valid input for the prompt.

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.

Invalidaciones:

Prompt<T>.onPreBubbleEvent(DialogContext dc, DialogEvent e)

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.

onPrompt

protected abstract CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options, Boolean isRetry)

Cuando se invalida en una clase derivada, solicita al usuario la entrada.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
state - Contiene el estado de la instancia actual del símbolo del sistema en la pila de diálogos.
options - Opciones de solicitud Objeto construido a partir de las opciones proporcionadas inicialmente en la llamada a prompt(String dialogId, PromptOptions options) .
isRetry - true si esta es la primera vez que esta instancia del cuadro de diálogo de solicitud está en la pila solicita al usuario la entrada; de lo contrario, false. Determina si se deben usar getPrompt() o getRetryPrompt().

Devoluciones:

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

onRecognize

protected abstract CompletableFuture> onRecognize(TurnContext turnContext, Map state, PromptOptions options)

Cuando se invalida en una clase derivada, intenta reconocer la entrada del usuario.

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
state - Contiene el estado de la instancia actual del símbolo del sistema en la pila de diálogos.
options - Opciones de solicitud Objeto construido a partir de las opciones proporcionadas inicialmente en la llamada a prompt(String dialogId, PromptOptions options) .

Devoluciones:

Un CompletableFuture que representa la operación asincrónica. 
     If the task is successful, the result describes the result of the
     recognition attempt.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Se llama cuando se ha solicitado un cuadro de diálogo de solicitud para volver a solicitar al usuario la entrada.

Invalidaciones:

Prompt<T>.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parámetros:

turnContext - Contexto para el turno actual de conversación con el usuario.
instance - Instancia del cuadro de diálogo en la pila.

Devoluciones:

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

resumeDialog

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

Se llama cuando un cuadro de diálogo de solicitud se reanuda como el diálogo activo en la pila de diálogos, como cuando se completa el diálogo activo anterior en la pila.

Invalidaciones:

Prompt<T>.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 - Enumeración que indica por qué se reanudó el cuadro de diálogo.
result - Opcional, valor devuelto del cuadro de diálogo anterior en la pila. El tipo del valor devuelto depende del cuadro de diálogo anterior.

Devoluciones:

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

Se aplica a