TextPrompt Clase

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

public class TextPrompt
extends Prompt<java.lang.String>

Solicita al usuario la entrada de texto.

Resumen del constructor

Constructor Description
TextPrompt(String dialogId)

Inicializa una nueva instancia de la clase TextPrompt.
TextPrompt(String dialogId, PromptValidator<String> validator)

Inicializa una nueva instancia de la clase TextPrompt.

Resumen del método

Modificador y tipo Método y descripción
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 java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Solicita al usuario que escriba.
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<java.lang.String>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Intenta reconocer la entrada del usuario.

Métodos heredados de Dialog

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

Métodos heredados de Prompt

appendChoices beginDialog continueDialog onPreBubbleEvent onPrompt onRecognize repromptDialog resumeDialog

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

TextPrompt

public TextPrompt(String dialogId)

Inicializa una nueva instancia de la clase TextPrompt.

Parámetros:

dialogId - Identificador que se va a asignar a este símbolo del sistema. El valor de dialogId debe ser único dentro del DialogSet o ComponentDialog al que se agrega el mensaje.

TextPrompt

public TextPrompt(String dialogId, PromptValidator validator)

Inicializa una nueva instancia de la clase TextPrompt.

Parámetros:

dialogId - Identificador que se va a asignar a este símbolo del sistema.
validator - Opcional, {@link PromptValidator{FoundChoice}} que contiene validación personalizada adicional para este mensaje. El valor de dialogId debe ser único dentro del DialogSet o ComponentDialog al que se agrega el mensaje.

Detalles del método

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:

TextPrompt.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 CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options, Boolean isRetry)

Solicita al usuario que escriba.

Invalidaciones:

TextPrompt.onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

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 de la pila solicita al usuario la entrada; de lo contrario, false.

Devoluciones:

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

onRecognize

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

Intenta reconocer la entrada del usuario.

Invalidaciones:

TextPrompt.onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

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. Si la tarea se realiza correctamente, el resultado describe el resultado del intento de reconocimiento.

Se aplica a