ChoicePrompt Clase

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

public class ChoicePrompt
extends Prompt<FoundChoice>

Pide a un usuario que seleccione una lista de opciones.

Resumen del constructor

Constructor Description
ChoicePrompt(String dialogId)

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

Inicializa una nueva instancia de la clase ChoicePrompt.
ChoicePrompt(String dialogId, Map<String,ChoiceFactoryOptions> choiceDefaults, PromptValidator<FoundChoice> validator, String defaultLocale)

Inicializa una nueva instancia de la clase ChoicePrompt.

Resumen del método

Modificador y tipo Método y descripción
ChoiceFactoryOptions getChoiceOptions()

Obtiene opciones adicionales que se pasan al ChoiceFactory y se usan para ajustar el estilo de las opciones representadas al usuario.
java.lang.String getDefaultLocale()

Establece o establece la configuración regional predeterminada que se usa para determinar el comportamiento específico del idioma del símbolo del sistema.
FindChoicesOptions getRecognizerOptions()

Obtiene o establece opciones adicionales que se pasan al método subyacente {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}.
ListStyle getStyle()

Obtiene el estilo que se va a usar al presentar la solicitud al usuario.
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<FoundChoice>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Intenta reconocer la entrada del usuario.
void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

Establece opciones adicionales que se pasan al ChoiceFactory y se usan para ajustar el estilo de las opciones representadas al usuario.
void setDefaultLocale(String defaultLocale)

Establece la configuración regional predeterminada que se usa para determinar el comportamiento específico del idioma del símbolo del sistema.
void setRecognizerOptions(FindChoicesOptions recognizerOptions)

Obtiene o establece opciones adicionales que se pasan al método subyacente {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}.
void setStyle(ListStyle style)

Establece el estilo que se va a usar al presentar la solicitud al 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

ChoicePrompt

public ChoicePrompt(String dialogId)

Inicializa una nueva instancia de la clase ChoicePrompt.

Parámetros:

dialogId - Identificador que se va a asignar a este símbolo del sistema.

ChoicePrompt

public ChoicePrompt(String dialogId, PromptValidator validator, String defaultLocale)

Inicializa una nueva instancia de la clase ChoicePrompt.

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.
defaultLocale - Opcional, la configuración regional predeterminada que se usa para determinar el comportamiento específico del idioma del símbolo del sistema. La configuración regional es un código ISO 639 de 2, 3 o 4 caracteres que representa un idioma o una familia de idiomas. 
                  The value of <xref uid="" data-throw-if-not-resolved="false" data-raw-source="dialogId"></xref> must be unique within the
                  <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="DialogSet"></xref> or <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="ComponentDialog"></xref> to which
                  the prompt is added. If the <xref uid="com.microsoft.bot.schema.Activity.locale" data-throw-if-not-resolved="false" data-raw-source="Activity#locale"></xref> of
                  the <xref uid="com.microsoft.bot.dialogs.DialogContext" data-throw-if-not-resolved="false" data-raw-source="DialogContext"></xref> .<xref uid="com.microsoft.bot.dialogs.DialogContext.context" data-throw-if-not-resolved="false" data-raw-source="DialogContext#context"></xref>
                  .<xref uid="" data-throw-if-not-resolved="false" data-raw-source="ITurnContext#activity"></xref> is specified, then that
                  local is used to determine language specific behavior;
                  otherwise the <xref uid="" data-throw-if-not-resolved="false" data-raw-source="defaultLocale"></xref> is used. US-English
                  is the used if no language or default locale is
                  available, or if the language or locale is not otherwise
                  supported.

ChoicePrompt

public ChoicePrompt(String dialogId, Map choiceDefaults, PromptValidator validator, String defaultLocale)

Inicializa una nueva instancia de la clase ChoicePrompt.

Parámetros:

dialogId - Identificador que se va a asignar a este símbolo del sistema.
choiceDefaults - Invalida el diccionario de _choiceDefaults compatibles con Bot Framework SDK (para la localización del mensaje). Debe pasarse a cada ConfirmPrompt que necesite los valores predeterminados de la elección personalizada. El valor de dialogId debe ser único dentro del DialogSet o ComponentDialog al que se agrega el mensaje. Si el Activity#locale del DialogContext .DialogContext#context .ITurnContext#activity se especifica y, a continuación, se usa esa configuración local para determinar el comportamiento específico del lenguaje; de lo contrario, se usa el defaultLocale. US-English es el que se usa si no hay ningún idioma o configuración regional predeterminada disponible o si no se admite el idioma o la configuración regional.
validator - Opcional, {@link PromptValidator{FoundChoice}} que contiene validación personalizada adicional para este mensaje.
defaultLocale - Opcional, la configuración regional predeterminada que se usa para determinar el comportamiento específico del idioma del símbolo del sistema. La configuración regional es un código ISO 639 de 2, 3 o 4 caracteres que representa un idioma o una familia de idiomas.

Detalles del método

getChoiceOptions

public ChoiceFactoryOptions getChoiceOptions()

Obtiene opciones adicionales que se pasan al ChoiceFactory y se usan para ajustar el estilo de las opciones representadas al usuario.

Devoluciones:

Opciones adicionales para presentar el conjunto de opciones.

getDefaultLocale

public String getDefaultLocale()

Establece o establece la configuración regional predeterminada que se usa para determinar el comportamiento específico del idioma del símbolo del sistema.

Devoluciones:

Configuración regional predeterminada que se usa para determinar el comportamiento específico del idioma del símbolo del sistema.

getRecognizerOptions

public FindChoicesOptions getRecognizerOptions()

Obtiene o establece opciones adicionales que se pasan al método subyacente {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)} subyacente.

Devoluciones:

Opciones para controlar la estrategia de reconocimiento.

getStyle

public ListStyle getStyle()

Obtiene el estilo que se va a usar al presentar la solicitud al usuario.

Devoluciones:

Estilo que se va a usar al presentar la solicitud al usuario.

onPrompt

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

Solicita al usuario que escriba.

Invalidaciones:

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

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

setChoiceOptions

public void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

Establece opciones adicionales que se pasan al ChoiceFactory y se usan para ajustar el estilo de las opciones representadas al usuario.

Parámetros:

choiceOptions - Opciones adicionales para presentar el conjunto de opciones.

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

Establece la configuración regional predeterminada que se usa para determinar el comportamiento específico del idioma del símbolo del sistema.

Parámetros:

defaultLocale - Configuración regional predeterminada que se usa para determinar el comportamiento específico del idioma del símbolo del sistema.

setRecognizerOptions

public void setRecognizerOptions(FindChoicesOptions recognizerOptions)

Obtiene o establece opciones adicionales que se pasan al método subyacente {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)} subyacente.

Parámetros:

recognizerOptions - Opciones para controlar la estrategia de reconocimiento.

setStyle

public void setStyle(ListStyle style)

Establece el estilo que se va a usar al presentar la solicitud al usuario.

Parámetros:

style - Estilo que se va a usar al presentar la solicitud al usuario.

Se aplica a