Dialog Classe

  • java.lang.Object
    • com.microsoft.bot.dialogs.Dialog

public abstract class Dialog

Classe de base pour tous les dialogues.

Récapitulatif du champ

Modificateur et type Champ et description
static final DialogTurnResult END_OF_TURN

Un DialogTurnResult qui indique que la boîte de dialogue actuelle est toujours active et attend l’entrée de l’utilisateur à son tour suivant.

Récapitulatif du constructeur

Constructeur Description
Dialog(String dialogId)

Initialise une nouvelle instance de la classe Dialog.

Résumé de la méthode

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

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

abstract java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

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

java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Appelé lorsque le dialogue 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 getId()

Obtient l’ID de la boîte de dialogue.

BotTelemetryClient getTelemetryClient()

Obtient la BotTelemetryClient à utiliser pour la journalisation.

java.lang.String getVersion()

Obtient une chaîne unique qui représente la version de cette boîte de dialogue.

protected static java.util.concurrent.CompletableFuture<DialogTurnResult> innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Implémentation partagée de l’exécution avec dialogue et boîte de dialogueManager.

protected java.lang.String onComputeId()

Calcule un ID pour la boîte de dialogue.

java.util.concurrent.CompletableFuture<java.lang.Boolean> onDialogEvent(DialogContext dc, DialogEvent e)

Appelé lorsqu’un événement a été déclenché, à l’aide de « DialogContext ».émettreEvent()', par la boîte de dialogue active ou par une boîte de dialogue que la boîte de dialogue active a démarré.

protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPostBubbleEvent(DialogContext dc, DialogEvent e)

Appelé après un événement a été bullené à tous les parents et n’a pas été géré.

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.

java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Appelé lorsque la boîte de dialogue doit inviter à nouveau l’utilisateur à entrer.

java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason)

Appelé lorsqu’un dialogue enfant a terminé ce tour, renvoyant le contrôle à ce dialogue.

java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Appelé lorsqu’un dialogue enfant a terminé ce tour, renvoyant le contrôle à ce dialogue.

static java.util.concurrent.CompletableFuture<java.lang.Void> run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor<DialogState> accessor)

Crée une pile de dialogues et démarre une boîte de dialogue, en l’appuyant sur la pile.

void setId(String withId)

Définit l’ID de la boîte de dialogue.

void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Définit la BotTelemetryClient à utiliser pour la journalisation.

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

END_OF_TURN

public static final DialogTurnResult END_OF_TURN

Un DialogTurnResult qui indique que la boîte de dialogue actuelle est toujours active et attend l’entrée de l’utilisateur à son tour suivant.

Détails du constructeur

Dialog

public Dialog(String dialogId)

Initialise une nouvelle instance de la classe Dialog.

Paramètres:

dialogId - ID à affecter à cette boîte de dialogue.

Détails de la méthode

beginDialog

public CompletableFuture beginDialog(DialogContext dc)

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

Paramètres:

dc - DialogContext pour le tour actuel de la conversation.

Retours:

Si la tâche réussit, le résultat indique si la boîte de dialogue est toujours active une fois le tour traité par la boîte de dialogue.

beginDialog

public abstract CompletableFuture beginDialog(DialogContext dc, Object options)

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

Paramètres:

dc - DialogContext pour le tour actuel de la conversation.
options - Informations initiales à transmettre à la boîte de dialogue.

Retours:

Si la tâche réussit, le résultat indique si la boîte de dialogue est toujours active une fois le tour traité par la boîte de dialogue.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

Si cette méthode n’est pas * substituée, la boîte de dialogue se termine automatiquement lorsque l’utilisateur répond.

Paramètres:

dc - DialogContext pour le tour actuel de la conversation.

Retours:

Si la tâche réussit, le résultat indique si la boîte de dialogue est toujours active une fois le tour traité par la boîte de dialogue. Le résultat peut également contenir une valeur de retour.

endDialog

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

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

Paramètres:

turnContext - Objet de contexte pour ce tour.
instance - Informations d’état associées à l’instance de cette boîte de dialogue sur la pile de dialogues.
reason - Raison pour laquelle le dialogue s’est terminé.

Retours:

CompletableFuture représentant l’opération asynchrone.

getId

public String getId()

Obtient l’ID de la boîte de dialogue.

Retours:

ID de la boîte de dialogue.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Obtient la BotTelemetryClient à utiliser pour la journalisation.

Retours:

BotTelemetryClient à utiliser pour la journalisation.

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.

Retours:

Chaîne unique qui ne doit changer que lorsque la boîte de dialogue a changé de manière à redémarrer la boîte de dialogue.

innerRun

protected static CompletableFuture innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Implémentation partagée de l’exécution avec Dialog et DialogManager.

Paramètres:

turnContext - TurnContext.
dialogId - ID de la boîte de dialogue.
dialogContext - The DialogContext.
stateConfiguration - The DialogStateManagerConfiguration.

Retours:

A DialogTurnResult.

onComputeId

protected String onComputeId()

Calcule un ID pour la boîte de dialogue.

Retours:

ID.

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

Appelé lorsqu’un événement a été déclenché, à l’aide de « DialogContext.emitEvent() », par la boîte de dialogue active ou par une boîte de dialogue que la boîte de dialogue active a démarré.

Paramètres:

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

Retours:

True si l’événement est géré par la boîte de dialogue actuelle et que le bouglage doit s’arrêter.

onPostBubbleEvent

protected CompletableFuture onPostBubbleEvent(DialogContext dc, DialogEvent e)

Appelé après un événement a été bullené à tous les parents et n’a pas été géré.

Il s’agit d’un bon endroit pour effectuer une logique de traitement par défaut pour un événement. Le retour de « true » empêche tout traitement de l’événement par les dialogues enfants.

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.

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.

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.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Appelé lorsque la boîte de dialogue doit inviter à nouveau l’utilisateur à entrer.

Paramètres:

turnContext - Objet de contexte pour ce tour.
instance - Informations d’état pour cette boîte de dialogue.

Retours:

CompletableFuture représentant l’opération asynchrone.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason)

Appelé lorsqu’un dialogue enfant a terminé ce tour, renvoyant le contrôle à ce dialogue.

En règle générale, le dialogue enfant a été démarré avec un appel à beginDialog(DialogContext dc, Object options) Toutefois, si la méthode replaceDialog(String dialogId) est appelée, le dialogue enfant logique peut être différent de l’original.

Si cette méthode n’est pas * substituée, la boîte de dialogue se termine automatiquement lorsque l’utilisateur répond.

Paramètres:

dc - Contexte de boîte de dialogue pour le tour actuel de la conversation.
reason - Raison pour laquelle le dialogue a repris.

Retours:

Si la tâche réussit, le résultat indique si cette boîte de dialogue est toujours active une fois que ce tour de dialogue a été traité.

resumeDialog

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

Appelé lorsqu’un dialogue enfant a terminé ce tour, renvoyant le contrôle à ce dialogue.

En règle générale, le dialogue enfant a été démarré avec un appel à beginDialog(DialogContext dc, Object options) Toutefois, si la méthode replaceDialog(String dialogId, Object options) est appelée, le dialogue enfant logique peut être différent de l’original.

Si cette méthode n’est pas * substituée, la boîte de dialogue se termine automatiquement lorsque l’utilisateur répond.

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:

Si la tâche réussit, le résultat indique si cette boîte de dialogue est toujours active une fois que ce tour de dialogue a été traité.

run

public static CompletableFuture run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor accessor)

Crée une pile de dialogues et démarre une boîte de dialogue, en l’appuyant sur la pile.

Paramètres:

dialog - Boîte de dialogue à démarrer.
turnContext - Contexte du tour actuel de la conversation.
accessor - Accesseur StatePropertyAccessor avec lequel gérer l’état de la pile de dialogues.

Retours:

Tâche représentant l’opération asynchrone.

setId

public void setId(String withId)

Définit l’ID de la boîte de dialogue.

Paramètres:

withId - ID de la boîte de dialogue.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Définit la BotTelemetryClient à utiliser pour la journalisation.

Paramètres:

withTelemetryClient - BotTelemetryClient à utiliser pour la journalisation.

S’applique à