WaterfallDialog Classe

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

public class WaterfallDialog
extends Dialog

Boîte de dialogue optimisée pour inviter un utilisateur avec une série de questions. Les cascades acceptent une pile de fonctions qui seront exécutées en séquence. Chaque étape en cascade peut poser une question à l’utilisateur et la réponse de l’utilisateur sera passée en tant qu’argument à l’étape en cascade suivante.

Récapitulatif du constructeur

Constructeur Description
WaterfallDialog(String dialogId, List<WaterfallStep> actions)

Initialise une nouvelle instance de la classe WaterfallDialog.

Résumé de la méthode

Modificateur et type Méthode et description
WaterfallDialog addStep(WaterfallStep step)

Ajoute une nouvelle étape à la cascade.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Appelé lorsque le dialogue en cascade est démarré et envoyé (push) sur la pile de dialogues.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Appelé lorsque le dialogue en cascade est _continue_, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Appelé lorsque la boîte de dialogue se termine.
java.lang.String getVersion()

Obtient une chaîne unique qui représente la version de cette boîte de dialogue.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onStep(WaterfallStepContext stepContext)

Appelé lorsqu’une étape en cascade individuelle est exécutée.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Appelé lorsqu’un dialogue en cascade enfant a terminé son tour, retournant le contrôle à ce dialogue.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> runStep(DialogContext dc, int index, DialogReason reason, Object result)

Excute une étape du dialogue en cascade.

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

WaterfallDialog

public WaterfallDialog(String dialogId, List actions)

Initialise une nouvelle instance de la classe WaterfallDialog.

Paramètres:

dialogId - ID de boîte de dialogue.
actions - Actions facultatives à définir par l’appelant.

Détails de la méthode

addStep

public WaterfallDialog addStep(WaterfallStep step)

Ajoute une nouvelle étape à la cascade.

Paramètres:

step - Étape à ajouter.

Retours:

Dialogue en cascade pour les appels Fluent à AddStep().

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Appelé lorsque le dialogue en cascade est démarré et envoyé (push) sur la pile de dialogues.

Remplacements:

WaterfallDialog.beginDialog(DialogContext dc, Object options)

Paramètres:

dc - Le
options - Informations initiales facultatives à transmettre à la boîte de dialogue.

Retours:

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.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Appelé lorsque le dialogue en cascade est _continue_, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.

Remplacements:

WaterfallDialog.continueDialog(DialogContext dc)

Paramètres:

dc - Le

Retours:

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
     result may also contain a return value.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Appelé lorsque la boîte de dialogue se termine.

Remplacements:

WaterfallDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Paramètres:

turnContext - Contexte du tour actuel de la conversation.
instance - Instance de la boîte de dialogue active.
reason - Raison pour laquelle la boîte de dialogue se termine.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

getVersion

public String getVersion()

Obtient une chaîne unique qui représente la version de cette boîte de dialogue. Si la version change entre les tours, le système de dialogue émet un événement DialogChanged.

Remplacements:

WaterfallDialog.getVersion()

Retours:

La version change lorsque les étapes comptent les modifications (car la boîte de dialogue n’a aucun moyen d’évaluer le contenu des étapes.

onStep

protected CompletableFuture onStep(WaterfallStepContext stepContext)

Appelé lorsqu’une étape en cascade individuelle est exécutée.

Paramètres:

stepContext - Contexte de l’étape en cascade à exécuter.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

resumeDialog

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

Appelé lorsqu’un dialogue en cascade enfant a terminé son tour, retournant le contrôle à ce dialogue.

Remplacements:

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

Paramètres:

dc - Contexte de boîte de dialogue pour le tour actuel de la conversation.
reason - Raison pour laquelle le dialogue a repris.
result - Facultatif, valeur retournée à partir de la boîte de dialogue appelée. Le type de la valeur retournée dépend de la boîte de dialogue enfant.

Retours:

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

runStep

protected CompletableFuture runStep(DialogContext dc, int index, DialogReason reason, Object result)

Excute une étape du dialogue en cascade.

Paramètres:

dc - DialogContext pour le tour actuel de la conversation.
index - Index de l’étape en cascade actuelle à exécuter.
reason - La raison pour laquelle l’étape en cascade est exécutée.
result - Résultat retourné par un dialogue appelé à l’étape en cascade précédente.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

S’applique à