Dialog Classe
- java.
lang. Object - com.
microsoft. bot. dialogs. Dialog
- com.
public abstract class Dialog
Classe de base pour tous les dialogues.
Récapitulatif du champ
| Modificateur et type | Champ et description |
|---|---|
|
static final
Dialog |
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<Dialog |
beginDialog(DialogContext dc)
Appelé lorsque le dialogue est démarré et envoyé (push) sur la pile de dialogues. |
|
abstract
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(DialogContext dc, Object options)
Appelé lorsque le dialogue est démarré et envoyé (push) sur la pile de dialogues. |
|
java.util.concurrent.CompletableFuture<Dialog |
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. |
|
Bot |
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<Dialog |
innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)
Implémentation partagée de l’exécution avec dialogue et boîte de dialogue |
| 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 « Dialog |
| 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<Dialog |
resumeDialog(DialogContext dc, DialogReason reason)
Appelé lorsqu’un dialogue enfant a terminé ce tour, renvoyant le contrôle à ce dialogue. |
|
java.util.concurrent.CompletableFuture<Dialog |
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
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:
Détails de la méthode
beginDialog
public CompletableFuture
Appelé lorsque le dialogue est démarré et envoyé (push) sur la pile de dialogues.
Paramètres:
Retours:
beginDialog
public abstract CompletableFuture
Appelé lorsque le dialogue est démarré et envoyé (push) sur la pile de dialogues.
Paramètres:
Retours:
continueDialog
public CompletableFuture
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:
Retours:
endDialog
public CompletableFuture
Appelé lorsque la boîte de dialogue se termine.
Paramètres:
Retours:
getId
public String getId()
Obtient l’ID de la boîte de dialogue.
Retours:
getTelemetryClient
public BotTelemetryClient getTelemetryClient()
Obtient la BotTelemetryClient à utiliser pour la journalisation.
Retours:
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:
innerRun
protected static CompletableFuture
Implémentation partagée de l’exécution avec Dialog et DialogManager.
Paramètres:
Retours:
onComputeId
protected String onComputeId()
Calcule un ID pour la boîte de dialogue.
Retours:
onDialogEvent
public CompletableFuture
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:
Retours:
onPostBubbleEvent
protected CompletableFuture
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:
Retours:
onPreBubbleEvent
protected CompletableFuture
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:
Retours:
repromptDialog
public CompletableFuture
Appelé lorsque la boîte de dialogue doit inviter à nouveau l’utilisateur à entrer.
Paramètres:
Retours:
resumeDialog
public CompletableFuture
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:
Retours:
resumeDialog
public CompletableFuture
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:
Retours:
run
public static CompletableFuture
Crée une pile de dialogues et démarre une boîte de dialogue, en l’appuyant sur la pile.
Paramètres:
Retours:
setId
public void setId(String withId)
Définit l’ID de la boîte de dialogue.
Paramètres:
setTelemetryClient
public void setTelemetryClient(BotTelemetryClient withTelemetryClient)
Définit la BotTelemetryClient à utiliser pour la journalisation.
Paramètres: