ChoicePrompt Classe

  • Referência
Pacote:
com.microsoft.bot.dialogs.prompts
Artefato Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class ChoicePrompt
extends Prompt<FoundChoice>

Solicita que um usuário selecione em uma lista de opções.

Resumo do Construtor

Construtor Description
ChoicePrompt(String dialogId)

Inicializa uma nova instância da classe ChoicePrompt.
ChoicePrompt(String dialogId, PromptValidator<FoundChoice> validator, String defaultLocale)

Inicializa uma nova instância da classe ChoicePrompt.
ChoicePrompt(String dialogId, Map<String,ChoiceFactoryOptions> choiceDefaults, PromptValidator<FoundChoice> validator, String defaultLocale)

Inicializa uma nova instância da classe ChoicePrompt.

Resumo do método

Modificador e tipo Método e descrição
ChoiceFactoryOptions getChoiceOptions()

Obtém opções adicionais passadas para o ChoiceFactory e usadas para ajustar o estilo de opções renderizado para o usuário.
java.lang.String getDefaultLocale()

Define ou define a localidade padrão usada para determinar o comportamento específico do idioma do prompt.
FindChoicesOptions getRecognizerOptions()

Obtém ou define opções adicionais passadas para o método subjacente {@link ChoiceRecognizeers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}.
ListStyle getStyle()

Obtém o estilo a ser usado ao apresentar o prompt ao usuário.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Solicita entrada ao usuário.
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<FoundChoice>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Tenta reconhecer a entrada do usuário.
void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

Define opções adicionais passadas para o ChoiceFactory e usadas para ajustar o estilo de opções renderizado para o usuário.
void setDefaultLocale(String defaultLocale)

Define a localidade padrão usada para determinar o comportamento específico do idioma do prompt.
void setRecognizerOptions(FindChoicesOptions recognizerOptions)

Obtém ou define opções adicionais passadas para o método subjacente {@link ChoiceRecognizeers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}.
void setStyle(ListStyle style)

Define o estilo a ser usado ao apresentar o prompt ao usuário.

Métodos herdados de Dialog

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

Métodos herdados de Prompt

appendChoices beginDialog continueDialog onPreBubbleEvent onPrompt onRecognize repromptDialog resumeDialog

Métodos herdados 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

Detalhes do construtor

ChoicePrompt

public ChoicePrompt(String dialogId)

Inicializa uma nova instância da classe ChoicePrompt.

Parâmetros:

dialogId - A ID a ser atribuída a esse prompt.

ChoicePrompt

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

Inicializa uma nova instância da classe ChoicePrompt.

Parâmetros:

dialogId - A ID a ser atribuída a esse prompt.
validator - Opcional, um {@link PromptValidator{FoundChoice}} que contém validação personalizada adicional para este prompt.
defaultLocale - Opcional, a localidade padrão usada para determinar o comportamento específico do idioma do prompt. A localidade é um código ISO 639 de 2, 3 ou 4 caracteres que representa uma família de idiomas ou 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 uma nova instância da classe ChoicePrompt.

Parâmetros:

dialogId - A ID a ser atribuída a esse prompt.
choiceDefaults - Substitui o dicionário de _choiceDefaults com suporte do SDK do Bot Framework (para localização de prompt). Deve ser passado para cada ConfirmPrompt que precise dos padrões de escolha personalizados. O valor de dialogId deve ser exclusivo no DialogSet ou ComponentDialog ao qual o prompt é adicionado. Se o Activity#locale do DialogContext .DialogContext#context.ITurnContext#activity é especificado e, em seguida, esse local é usado para determinar o comportamento específico da linguagem; caso contrário, o defaultLocale é usado. US-English será usado se nenhum idioma ou localidade padrão estiver disponível ou se não houver suporte para o idioma ou localidade.
validator - Opcional, um {@link PromptValidator{FoundChoice}} que contém validação personalizada adicional para este prompt.
defaultLocale - Opcional, a localidade padrão usada para determinar o comportamento específico do idioma do prompt. A localidade é um código ISO 639 de 2, 3 ou 4 caracteres que representa uma família de idiomas ou idiomas.

Detalhes do método

getChoiceOptions

public ChoiceFactoryOptions getChoiceOptions()

Obtém opções adicionais passadas para o ChoiceFactory e usadas para ajustar o estilo de opções renderizado para o usuário.

Retornos:

Opções adicionais para apresentar o conjunto de opções.

getDefaultLocale

public String getDefaultLocale()

Define ou define a localidade padrão usada para determinar o comportamento específico do idioma do prompt.

Retornos:

A localidade padrão usada para determinar o comportamento específico do idioma do prompt.

getRecognizerOptions

public FindChoicesOptions getRecognizerOptions()

Obtém ou define opções adicionais passadas para o método {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}.

Retornos:

Opções para controlar a estratégia de reconhecimento.

getStyle

public ListStyle getStyle()

Obtém o estilo a ser usado ao apresentar o prompt ao usuário.

Retornos:

O estilo a ser usado ao apresentar o prompt ao usuário.

onPrompt

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

Solicita entrada ao usuário.

Substituições:

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

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
state - Contém o estado da instância atual do prompt na pilha de diálogos.
options - Um objeto de opções de prompt construído a partir das opções inicialmente fornecidas na chamada para prompt(String dialogId, PromptOptions options) .
isRetry - true se esta for a primeira vez que essa instância de diálogo de prompt na pilha está solicitando entrada ao usuário; caso contrário, false.

Retornos:

Um CompletableFuture que representa a operação assíncrona.

onRecognize

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

Tenta reconhecer a entrada do usuário.

Substituições:

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

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
state - Contém o estado da instância atual do prompt na pilha de diálogos.
options - Um objeto de opções de prompt construído a partir das opções inicialmente fornecidas na chamada para prompt(String dialogId, PromptOptions options) .

Retornos:

Um CompletableFuture que representa a operação assíncrona. Se a tarefa for bem-sucedida, o resultado descreverá o resultado da tentativa de reconhecimento.

setChoiceOptions

public void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

Define opções adicionais passadas para o ChoiceFactory e usadas para ajustar o estilo de opções renderizado para o usuário.

Parâmetros:

choiceOptions - Opções adicionais para apresentar o conjunto de opções.

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

Define a localidade padrão usada para determinar o comportamento específico do idioma do prompt.

Parâmetros:

defaultLocale - A localidade padrão usada para determinar o comportamento específico do idioma do prompt.

setRecognizerOptions

public void setRecognizerOptions(FindChoicesOptions recognizerOptions)

Obtém ou define opções adicionais passadas para o método {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)}.

Parâmetros:

recognizerOptions - Opções para controlar a estratégia de reconhecimento.

setStyle

public void setStyle(ListStyle style)

Define o estilo a ser usado ao apresentar o prompt ao usuário.

Parâmetros:

style - O estilo a ser usado ao apresentar o prompt ao usuário.

Aplica-se a