Prompt<T> Classe

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

Paramètres de type

T

Tapez l’invite pour laquelle vous avez créé.

public abstract class Prompt
extends Dialog

Définit le comportement principal des dialogues d’invite. Lorsque l’invite se termine, elle doit retourner un objet qui représente la valeur qui a été invité. Utilisez add(Dialog dialog) ou addDialog(Dialog dialog) pour ajouter une invite à un jeu de dialogues ou une boîte de dialogue composant, respectivement. Utilisez prompt(String dialogId, PromptOptions options) ou beginDialog(String dialogId, Object options) pour démarrer l’invite. Si vous démarrez une invite à partir d’un WaterfallStep dans un WaterfallDialog, le résultat de l’invite sera disponible à l’étape suivante de la cascade.

Récapitulatif du champ

Modificateur et type Champ et description
static final java.lang.String ATTEMPTCOUNTKEY

Récapitulatif du constructeur

Constructeur Description
Prompt(String dialogId, PromptValidator<T> validator)

Initialise une nouvelle instance de la classe {@link Prompt{T}}.

Résumé de la méthode

Modificateur et type Méthode et description
protected Activity appendChoices(Activity prompt, String channelId, List<Choice> choices, ListStyle style, ChoiceFactoryOptions options)

En cas de substitution dans une classe dérivée, ajoute des choix à l’activité lorsque l’utilisateur est invité à entrer l’entrée.
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.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

Appelé avant qu’un événement ne soit mis en bulle à son parent.
protected abstract 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 abstract java.util.concurrent.CompletableFuture<PromptRecognizerResult<T>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

En cas de substitution dans une classe dérivée, tente de reconnaître l’entrée de l’utilisateur.
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 champ

ATTEMPTCOUNTKEY

public static final String ATTEMPTCOUNTKEY

Détails du constructeur

Prompt

public Prompt(String dialogId, PromptValidator validator)

Initialise une nouvelle instance de la classe {@link Prompt{T}}. Appelé à partir de constructeurs dans des classes dérivées pour initialiser la classe {@link Prompt{T}}.

Paramètres:

dialogId - ID à affecter à cette invite.
validator - Facultatif, un {@link PromptValidator{T}} qui contient une validation personnalisée supplémentaire pour 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="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.

Détails de la méthode

appendChoices

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

En cas de substitution dans une classe dérivée, ajoute des choix à l’activité lorsque l’utilisateur est invité à entrer l’entrée.

Paramètres:

prompt - Activité à laquelle ajouter les choix.
channelId - ID du canal de l’utilisateur.
choices - Choix à ajouter.
style - Indique comment les choix doivent être présentés à l’utilisateur.
options - Options de mise en forme à utiliser lors de la présentation des choix.

Retours:

Un CompletableFuture représentant l’opération asynchrone. 
     If the task is successful, the result contains the updated activity.

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:

Prompt<T>.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:

Prompt<T>.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.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

Appelé avant qu’un événement ne soit mis en bulle à son parent. Il s’agit d’un bon endroit pour effectuer l’interception d’un événement, car le retour de « true » empêchera tout autre boublage de l’événement aux parents des dialogues et empêchera également les dialogues enfants d’effectuer leur traitement par défaut.

Remplacements:

Prompt<T>.onPreBubbleEvent(DialogContext dc, DialogEvent e)

Paramètres:

dc - Contexte de boîte de dialogue pour le tour de conversation actuel.
e - Événement déclenché.

Retours:

Indique si l’événement est géré par la boîte de dialogue active et que le traitement ultérieur doit s’arrêter.

onPrompt

protected abstract 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 - true si c’est la première fois que cette instance de boîte de dialogue d’invite se trouve sur la pile invite l’utilisateur à entrer ; sinon, false. Détermine si getPrompt() ou getRetryPrompt() doit être utilisé.

Retours:

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

onRecognize

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

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

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:

Prompt<T>.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:

Prompt<T>.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 à