ActivityPrompt Classe

  • Référence
Paquet:
com.microsoft.bot.dialogs.prompts
Artefact Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class ActivityPrompt
extends Dialog

Définit le comportement principal d’une boîte de dialogue d’invite qui attend la réception d’une activité. Cette invite nécessite qu’un validateur soit transmis et est utile lors de l’attente d’activités non-message comme un événement à recevoir. Le validateur peut ignorer les activités reçues jusqu’à ce que le type d’activité attendu soit reçu.

Récapitulatif du constructeur

Constructeur Description
ActivityPrompt(String dialogId, PromptValidator<Activity> validator)

Initialise une nouvelle instance de la classe ActivityPrompt.

Résumé de la méthode

Modificateur et type Méthode et description
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Appelé lorsqu’une boîte de dialogue d’invite est envoyée (push) sur la pile de dialogues et est activée.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Appelé lorsqu’une boîte de dialogue d’invite est la boîte de dialogue active et que l’utilisateur a répondu avec une nouvelle activité.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

En cas de substitution dans une classe dérivée, invite l’utilisateur à entrer son entrée.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

En cas de substitution dans une classe dérivée, invite l’utilisateur à entrer son entrée.
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<Activity>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

En cas de substitution dans une classe dérivée, tente de reconnaître l’activité entrante.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Appelé lorsqu’une boîte de dialogue d’invite a été demandée pour inviter l’utilisateur à entrer à nouveau.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Appelé lorsqu’une boîte de dialogue d’invite reprend la boîte de dialogue active sur la pile de dialogues, par exemple lorsque la boîte de dialogue active précédente sur la pile se termine.

Méthodes héritées de Dialog

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

Méthodes héritées 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

Détails du constructeur

ActivityPrompt

public ActivityPrompt(String dialogId, PromptValidator validator)

Initialise une nouvelle instance de la classe ActivityPrompt. Appelé à partir de constructeurs dans des classes dérivées pour initialiser la classe ActivityPrompt.

Paramètres:

dialogId - ID à affecter à cette invite.
validator - Une PromptValidator<T> qui contient la validation de cette invite. 
              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.

Détails de la méthode

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Appelé lorsqu’une boîte de dialogue d’invite est envoyée (push) sur la pile de dialogues et est activée.

Remplacements:

ActivityPrompt.beginDialog(DialogContext dc, Object options)

Paramètres:

dc - Contexte de boîte de dialogue pour le tour actuel de la conversation.
options - Facultatif, des informations supplémentaires à transmettre à l’invite en cours de démarrage.

Retours:

Un CompletableFuture représentant l’opération asynchrone. 
     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)

Appelé lorsqu’une boîte de dialogue d’invite est la boîte de dialogue active et que l’utilisateur a répondu avec une nouvelle activité.

Remplacements:

ActivityPrompt.continueDialog(DialogContext dc)

Paramètres:

dc - Contexte de boîte de dialogue pour le tour de conversation actuel.

Retours:

Un CompletableFuture représentant l’opération asynchrone. 
     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)

En cas de substitution dans une classe dérivée, invite l’utilisateur à entrer son entrée.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
state - Contient l’état de l’instance actuelle de l’invite sur la pile de dialogues.
options - Objet d’invite construit à partir des options initialement fournies dans l’appel à prompt(String dialogId, PromptOptions options) .

Retours:

Un CompletableFuture représentant l’opération asynchrone.

onPrompt

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

En cas de substitution dans une classe dérivée, invite l’utilisateur à entrer son entrée.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
state - Contient l’état de l’instance actuelle de l’invite sur la pile de dialogues.
options - Objet d’invite construit à partir des options initialement fournies dans l’appel à prompt(String dialogId, PromptOptions options) .
isRetry - Une Boolean représentant si l’invite est une nouvelle tentative.

Retours:

Un CompletableFuture représentant le résultat de l’opération asynchrone.

onRecognize

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

En cas de substitution dans une classe dérivée, tente de reconnaître l’activité entrante.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
state - Contient l’état de l’instance actuelle de l’invite sur la pile de dialogues.
options - Objet d’invite construit à partir des options initialement fournies dans l’appel à prompt(String dialogId, PromptOptions options) .

Retours:

Un CompletableFuture représentant l’opération asynchrone. 
     If the task is successful, the result describes the result of the
     recognition attempt.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Appelé lorsqu’une boîte de dialogue d’invite a été demandée pour inviter l’utilisateur à entrer à nouveau.

Remplacements:

ActivityPrompt.repromptDialog(TurnContext turnContext, DialogInstance instance)

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
instance - Instance de la boîte de dialogue sur la pile.

Retours:

Un CompletableFuture représentant l’opération asynchrone.

resumeDialog

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

Appelé lorsqu’une boîte de dialogue d’invite reprend la boîte de dialogue active sur la pile de dialogues, par exemple lorsque la boîte de dialogue active précédente sur la pile se termine.

Remplacements:

ActivityPrompt.resumeDialog(DialogContext dc, DialogReason reason, Object result)

Paramètres:

dc - Contexte de boîte de dialogue pour le tour actuel de la conversation.
reason - Énumération indiquant pourquoi le dialogue a repris.
result - Facultatif, valeur retournée par la boîte de dialogue précédente sur la pile. Le type de la valeur retournée dépend de la boîte de dialogue précédente.

Retours:

Un CompletableFuture représentant l’opération asynchrone. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

S’applique à