TextPrompt Classe

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

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

Invite l’utilisateur à entrer du texte.

Récapitulatif du constructeur

Constructeur Description
TextPrompt(String dialogId)

Initialise une nouvelle instance de la classe TextPrompt.
TextPrompt(String dialogId, PromptValidator<String> validator)

Initialise une nouvelle instance de la classe TextPrompt.

Résumé de la méthode

Modificateur et type Méthode et description
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 java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Invite l’utilisateur à entrer.
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<java.lang.String>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Tente de reconnaître l’entrée de l’utilisateur.

Méthodes héritées de Dialog

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

Méthodes héritées de Prompt

appendChoices beginDialog continueDialog onPreBubbleEvent onPrompt onRecognize repromptDialog resumeDialog

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

TextPrompt

public TextPrompt(String dialogId)

Initialise une nouvelle instance de la classe TextPrompt.

Paramètres:

dialogId - ID à affecter à cette invite. La valeur de dialogId doit être unique dans le DialogSet ou ComponentDialog auquel l’invite est ajoutée.

TextPrompt

public TextPrompt(String dialogId, PromptValidator validator)

Initialise une nouvelle instance de la classe TextPrompt.

Paramètres:

dialogId - ID à affecter à cette invite.
validator - Facultatif, un {@link PromptValidator{FoundChoice}} qui contient une validation personnalisée supplémentaire pour cette invite. La valeur de dialogId doit être unique dans le DialogSet ou ComponentDialog auquel l’invite est ajoutée.

Détails de la méthode

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:

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

Invite l’utilisateur à entrer.

Remplacements:

TextPrompt.onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

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 sur la pile invite l’utilisateur à entrer ; sinon, false.

Retours:

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

onRecognize

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

Tente de reconnaître l’entrée de l’utilisateur.

Remplacements:

TextPrompt.onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

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. Si la tâche réussit, le résultat décrit le résultat de la tentative de reconnaissance.

S’applique à