Prompt<T> Classe

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

Parametri di tipo

T

Digitare per cui viene creato il prompt.

public abstract class Prompt
extends Dialog

Definisce il comportamento principale dei dialoghi di richiesta. Al termine della richiesta, deve restituire un oggetto che rappresenta il valore richiesto. Usare add(Dialog dialog) o addDialog(Dialog dialog) per aggiungere una richiesta rispettivamente a un set di dialoghi o a un dialogo componente. Usare prompt(String dialogId, PromptOptions options) o beginDialog(String dialogId, Object options) per avviare il prompt. Se si avvia una richiesta da un WaterfallStep in un WaterfallDialog, il risultato della richiesta sarà disponibile nel passaggio successivo della cascata.

Riepilogo dei campi

Modificatore e tipo Campo e descrizione
static final java.lang.String ATTEMPTCOUNTKEY

Riepilogo dei costruttori

Costruttore Descrizione
Prompt(String dialogId, PromptValidator<T> validator)

Inizializza una nuova istanza della classe {@link Prompt{T}}.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
protected Activity appendChoices(Activity prompt, String channelId, List<Choice> choices, ListStyle style, ChoiceFactoryOptions options)

Quando sottoposto a override in una classe derivata, aggiunge le scelte all'attività quando all'utente viene richiesto l'input.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Viene chiamato quando viene eseguito il push di una finestra di dialogo nello stack di dialoghi e viene attivato.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Chiamato quando una finestra di dialogo di richiesta è la finestra di dialogo attiva e l'utente ha risposto con una nuova attività.
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

Chiamato prima che un evento venga visualizzato nell'elemento padre.
protected abstract java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Quando sottoposto a override in una classe derivata, richiede all'utente di immettere l'input.
protected abstract java.util.concurrent.CompletableFuture<PromptRecognizerResult<T>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Quando sottoposto a override in una classe derivata, tenta di riconoscere l'input dell'utente.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Chiamato quando è stata richiesta una finestra di dialogo di richiesta per richiedere di nuovo l'input all'utente.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Viene chiamato quando una finestra di dialogo di richiesta riprende a essere la finestra di dialogo attiva nello stack di dialoghi, ad esempio quando viene completata la finestra di dialogo attiva precedente nello stack.

Metodi ereditati da Dialog

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

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 del campo

ATTEMPTCOUNTKEY

public static final String ATTEMPTCOUNTKEY

Dettagli costruttore

Prompt

public Prompt(String dialogId, PromptValidator validator)

Inizializza una nuova istanza della classe {@link Prompt{T}}. Chiamato dai costruttori nelle classi derivate per inizializzare la classe {@link Prompt{T}}.

Parametri:

dialogId - ID da assegnare a questa richiesta.
validator - Facoltativo, {@link PromptValidator{T}} che contiene una convalida personalizzata aggiuntiva per questa richiesta. 
              The value of dialogId must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.bot.dialogs.DialogSet"></xref> or
              <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.bot.dialogs.ComponentDialog"></xref> to which
              the prompt is added.

Dettagli metodo

appendChoices

protected Activity appendChoices(Activity prompt, String channelId, List choices, ListStyle style, ChoiceFactoryOptions options)

Quando sottoposto a override in una classe derivata, aggiunge le scelte all'attività quando all'utente viene richiesto l'input.

Parametri:

prompt - Attività a cui aggiungere le scelte.
channelId - ID del canale dell'utente.
choices - Opzioni da accodare.
style - Indica la modalità di presentazione delle scelte all'utente.
options - Opzioni di formattazione da utilizzare per la presentazione delle scelte.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona. 
     If the task is successful, the result contains the updated activity.

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Viene chiamato quando viene eseguito il push di una finestra di dialogo nello stack di dialoghi e viene attivato.

Override:

Prompt<T>.beginDialog(DialogContext dc, Object options)

Parametri:

dc - Contesto del dialogo per il turno corrente della conversazione.
options - Informazioni aggiuntive facoltative da passare alla richiesta avviata.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona. 
     If the task is successful, the result indicates whether the prompt is
     still active after the turn has been processed by the prompt.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Chiamato quando una finestra di dialogo di richiesta è la finestra di dialogo attiva e l'utente ha risposto con una nuova attività.

Override:

Prompt<T>.continueDialog(DialogContext dc)

Parametri:

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

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     prompt generally continues to receive the user's replies until it
     accepts the user's reply as valid input for the prompt.

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:

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

Quando sottoposto a override in una classe derivata, richiede all'utente di immettere l'input.

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 è la prima volta che questa istanza della finestra di dialogo di richiesta si trova nello stack richiede all'utente l'input; in caso contrario, false. Determina se utilizzare getPrompt() o getRetryPrompt().

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona.

onRecognize

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

Quando sottoposto a override in una classe derivata, tenta di riconoscere l'input dell'utente.

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. 
     If the task is successful, the result describes the result of the
     recognition attempt.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Chiamato quando è stata richiesta una finestra di dialogo di richiesta per richiedere di nuovo l'input all'utente.

Override:

Prompt<T>.repromptDialog(TurnContext turnContext, DialogInstance instance)

Parametri:

turnContext - Contesto per il turno di conversazione corrente con l'utente.
instance - Istanza del dialogo nello stack.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

Viene chiamato quando una finestra di dialogo di richiesta riprende a essere la finestra di dialogo attiva nello stack di dialoghi, ad esempio quando viene completata la finestra di dialogo attiva precedente nello stack.

Override:

Prompt<T>.resumeDialog(DialogContext dc, DialogReason reason, Object result)

Parametri:

dc - Contesto del dialogo per il turno corrente della conversazione.
reason - Enumerazione che indica il motivo per cui il dialogo è stato ripreso.
result - Valore facoltativo restituito dalla finestra di dialogo precedente nello stack. Il tipo del valore restituito dipende dalla finestra di dialogo precedente.

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

Si applica a