TextPrompt Classe

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

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

Richiede all'utente l'input di testo.

Riepilogo dei costruttori

Costruttore Descrizione
TextPrompt(String dialogId)

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

Inizializza una nuova istanza della classe TextPrompt.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

Chiamato prima che un evento venga visualizzato nell'elemento padre.
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<java.lang.String>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Tenta di riconoscere l'input dell'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

TextPrompt

public TextPrompt(String dialogId)

Inizializza una nuova istanza della classe TextPrompt.

Parametri:

dialogId - ID da assegnare a questa richiesta. Il valore di dialogId deve essere univoco all'interno del DialogSet o ComponentDialog a cui viene aggiunto il prompt.

TextPrompt

public TextPrompt(String dialogId, PromptValidator validator)

Inizializza una nuova istanza della classe TextPrompt.

Parametri:

dialogId - ID da assegnare a questa richiesta.
validator - Facoltativo, {@link PromptValidator{FoundChoice}} che contiene una convalida personalizzata aggiuntiva per questa richiesta. Il valore di dialogId deve essere univoco all'interno del DialogSet o ComponentDialog a cui viene aggiunto il prompt.

Dettagli metodo

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

Chiamato prima che un evento venga visualizzato nell'elemento padre. Questo è un buon posto per eseguire l'intercettazione di un evento in quanto la restituzione di "true" impedirà qualsiasi ulteriore bubbling dell'evento agli elementi padre dei dialoghi e impedirà anche a qualsiasi dialogo figlio di eseguire l'elaborazione predefinita.

Override:

TextPrompt.onPreBubbleEvent(DialogContext dc, DialogEvent e)

Parametri:

dc - Contesto del dialogo per il turno corrente della conversazione.
e - Evento generato.

Restituisce:

Indica se l'evento viene gestito dal dialogo corrente e l'ulteriore elaborazione deve essere arrestata.

onPrompt

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

Richiede l'input all'utente.

Override:

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

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

Si applica a