ActivityPrompt Classe

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

public class ActivityPrompt
extends Dialog

Definisce il comportamento principale di una finestra di dialogo di richiesta che attende la ricezione di un'attività. Questo prompt richiede che venga passato un validator ed è utile quando si attendono attività non di messaggio come un evento da ricevere. Il validator può ignorare le attività ricevute fino a quando non viene ricevuto il tipo di attività previsto.

Riepilogo dei costruttori

Costruttore Descrizione
ActivityPrompt(String dialogId, PromptValidator<Activity> validator)

Inizializza una nuova istanza della classe ActivityPrompt.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
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.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

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

Quando sottoposto a override in una classe derivata, tenta di riconoscere l'attività in ingresso.
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 costruttore

ActivityPrompt

public ActivityPrompt(String dialogId, PromptValidator validator)

Inizializza una nuova istanza della classe ActivityPrompt. Chiamato dai costruttori nelle classi derivate per inizializzare la classe ActivityPrompt.

Parametri:

dialogId - ID da assegnare a questa richiesta.
validator - Un PromptValidator<T> che contiene la convalida 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="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.

Dettagli metodo

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:

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

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

onPrompt

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

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

Restituisce:

Oggetto CompletableFuture che rappresenta l'operazione asincrona.

onPrompt

protected 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 - Oggetto Boolean che rappresenta se il prompt è un nuovo tentativo.

Restituisce:

Oggetto CompletableFuture che rappresenta il risultato dell'operazione asincrona.

onRecognize

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

Quando sottoposto a override in una classe derivata, tenta di riconoscere l'attività in ingresso.

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:

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

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