ChoicePrompt Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.dialogs.prompts
Artefatto Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class ChoicePrompt
extends Prompt<FoundChoice>

Richiede a un utente di selezionare un elenco di scelte.

Riepilogo dei costruttori

Costruttore Descrizione
ChoicePrompt(String dialogId)

Inizializza una nuova istanza della classe ChoicePrompt.
ChoicePrompt(String dialogId, PromptValidator<FoundChoice> validator, String defaultLocale)

Inizializza una nuova istanza della classe ChoicePrompt.
ChoicePrompt(String dialogId, Map<String,ChoiceFactoryOptions> choiceDefaults, PromptValidator<FoundChoice> validator, String defaultLocale)

Inizializza una nuova istanza della classe ChoicePrompt.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
ChoiceFactoryOptions getChoiceOptions()

Ottiene opzioni aggiuntive passate al ChoiceFactory e utilizzate per modificare lo stile delle scelte di cui è stato eseguito il rendering all'utente.
java.lang.String getDefaultLocale()

Imposta o imposta le impostazioni locali predefinite utilizzate per determinare il comportamento specifico della lingua del prompt.
FindChoicesOptions getRecognizerOptions()

Ottiene o imposta opzioni aggiuntive passate al metodo {@link ChoiceRecognizers#recognizerChoices(String, IList{Choice}, FindOptionsOptions)}.
ListStyle getStyle()

Ottiene lo stile da utilizzare quando si presenta la richiesta all'utente.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Richiede l'input all'utente.
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<FoundChoice>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Tenta di riconoscere l'input dell'utente.
void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

Imposta opzioni aggiuntive passate al ChoiceFactory e utilizzate per modificare lo stile delle scelte di cui è stato eseguito il rendering all'utente.
void setDefaultLocale(String defaultLocale)

Imposta le impostazioni locali predefinite utilizzate per determinare il comportamento specifico della lingua del prompt.
void setRecognizerOptions(FindChoicesOptions recognizerOptions)

Ottiene o imposta opzioni aggiuntive passate al metodo {@link ChoiceRecognizers#recognizerChoices(String, IList{Choice}, FindOptionsOptions)}.
void setStyle(ListStyle style)

Imposta lo stile da utilizzare quando si presenta la richiesta all'utente.

Metodi ereditati da Dialog

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

Metodi ereditati da Prompt

appendChoices beginDialog continueDialog onPreBubbleEvent onPrompt onRecognize repromptDialog resumeDialog

Metodi ereditati da 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

Dettagli costruttore

ChoicePrompt

public ChoicePrompt(String dialogId)

Inizializza una nuova istanza della classe ChoicePrompt.

Parametri:

dialogId - ID da assegnare a questa richiesta.

ChoicePrompt

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

Inizializza una nuova istanza della classe ChoicePrompt.

Parametri:

dialogId - ID da assegnare a questa richiesta.
validator - Facoltativo, {@link PromptValidator{FoundChoice}} che contiene una convalida personalizzata aggiuntiva per questa richiesta.
defaultLocale - Facoltativo, le impostazioni locali predefinite usate per determinare il comportamento specifico della lingua del prompt. Le impostazioni locali sono un codice ISO 639 di 2, 3 o 4 caratteri che rappresenta una lingua o una famiglia di lingue. 
                  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)

Inizializza una nuova istanza della classe ChoicePrompt.

Parametri:

dialogId - ID da assegnare a questa richiesta.
choiceDefaults - Esegue l'override del dizionario delle _choiceDefaults supportate da Bot Framework SDK (per la localizzazione della richiesta). Deve essere passato a ogni ConfirmPrompt che richiede le impostazioni predefinite per la scelta personalizzata. Il valore di dialogId deve essere univoco all'interno del DialogSet o ComponentDialog a cui viene aggiunto il prompt. Se il Activity#locale del DialogContext .DialogContext#context .ITurnContext#activity viene specificato, quindi viene usato localmente per determinare il comportamento specifico della lingua; in caso contrario, viene utilizzata la defaultLocale. US-English viene usato se non è disponibile alcuna lingua o impostazioni locali predefinite oppure se la lingua o le impostazioni locali non sono altrimenti supportate.
validator - Facoltativo, {@link PromptValidator{FoundChoice}} che contiene una convalida personalizzata aggiuntiva per questa richiesta.
defaultLocale - Facoltativo, le impostazioni locali predefinite usate per determinare il comportamento specifico della lingua del prompt. Le impostazioni locali sono un codice ISO 639 di 2, 3 o 4 caratteri che rappresenta una lingua o una famiglia di lingue.

Dettagli metodo

getChoiceOptions

public ChoiceFactoryOptions getChoiceOptions()

Ottiene opzioni aggiuntive passate al ChoiceFactory e utilizzate per modificare lo stile delle scelte di cui è stato eseguito il rendering all'utente.

Restituisce:

Opzioni aggiuntive per la presentazione del set di scelte.

getDefaultLocale

public String getDefaultLocale()

Imposta o imposta le impostazioni locali predefinite utilizzate per determinare il comportamento specifico della lingua del prompt.

Restituisce:

Impostazioni locali predefinite utilizzate per determinare il comportamento specifico della lingua del prompt.

getRecognizerOptions

public FindChoicesOptions getRecognizerOptions()

Ottiene o imposta opzioni aggiuntive passate al metodo {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)} sottostante.

Restituisce:

Opzioni per controllare la strategia di riconoscimento.

getStyle

public ListStyle getStyle()

Ottiene lo stile da utilizzare quando si presenta la richiesta all'utente.

Restituisce:

Stile da utilizzare quando si presenta la richiesta all'utente.

onPrompt

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

Richiede l'input all'utente.

Override:

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
state - Contiene lo stato per l'istanza corrente del prompt nello stack di dialoghi.
options - Opzioni di richiesta Oggetto costruito dalle opzioni fornite inizialmente nella chiamata a prompt(String dialogId, PromptOptions options) .
isRetry - true se questa è la prima volta che questa istanza della finestra di dialogo di richiesta nello stack richiede all'utente l'input; in caso contrario, false.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona.

onRecognize

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

Tenta di riconoscere l'input dell'utente.

Override:

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

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
state - Contiene lo stato per l'istanza corrente del prompt nello stack di dialoghi.
options - Opzioni di richiesta Oggetto costruito dalle opzioni fornite inizialmente nella chiamata a prompt(String dialogId, PromptOptions options) .

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona. Se l'attività ha esito positivo, il risultato descrive il risultato del tentativo di riconoscimento.

setChoiceOptions

public void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

Imposta opzioni aggiuntive passate al ChoiceFactory e utilizzate per modificare lo stile delle scelte di cui è stato eseguito il rendering all'utente.

Parametri:

choiceOptions - Opzioni aggiuntive per la presentazione del set di scelte.

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

Imposta le impostazioni locali predefinite utilizzate per determinare il comportamento specifico della lingua del prompt.

Parametri:

defaultLocale - Impostazioni locali predefinite utilizzate per determinare il comportamento specifico della lingua del prompt.

setRecognizerOptions

public void setRecognizerOptions(FindChoicesOptions recognizerOptions)

Ottiene o imposta opzioni aggiuntive passate al metodo {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)} sottostante.

Parametri:

recognizerOptions - Opzioni per controllare la strategia di riconoscimento.

setStyle

public void setStyle(ListStyle style)

Imposta lo stile da utilizzare quando si presenta la richiesta all'utente.

Parametri:

style - Stile da utilizzare quando si presenta la richiesta all'utente.

Si applica a