DialogContext Classe
- java.
lang. Object - com.
microsoft. bot. dialogs. DialogContext
- com.
public class DialogContext
Fournit un contexte pour l’état actuel de la pile de dialogues.
Récapitulatif du constructeur
| Constructeur | Description |
|---|---|
| DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState) |
Initialise une nouvelle instance de la classe Dialog |
| DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState) |
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(String dialogId)
Démarre un nouveau dialogue et l’envoie (push) sur la pile de dialogues. |
|
java.util.concurrent.CompletableFuture<Dialog |
beginDialog(String dialogId, Object options)
Démarre un nouveau dialogue et l’envoie (push) sur la pile de dialogues. |
|
java.util.concurrent.CompletableFuture<Dialog |
cancelAllDialogs()
Méthode d’assistance pour cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) qui n’annule pas les dialogues parents ou passe et l’événement. |
|
java.util.concurrent.CompletableFuture<Dialog |
cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)
Supprime toute pile de dialogues existante, ce qui annule tous les dialogues de la pile. |
|
java.util.concurrent.CompletableFuture<Dialog |
continueDialog()
Poursuit l’exécution du dialogue actif, s’il en existe un, en transmettant le contexte |
| java.util.concurrent.CompletableFuture<java.lang.Boolean> | emitEvent(String name) |
| java.util.concurrent.CompletableFuture<java.lang.Boolean> | emitEvent(String name, Object value, boolean bubble, boolean fromLeaf) |
|
java.util.concurrent.CompletableFuture<Dialog |
endDialog()
Méthode d’assistance qui fournit un résultat Null à endDialog(Object result). |
|
java.util.concurrent.CompletableFuture<Dialog |
endDialog(Object result)
Termine une boîte de dialogue en la désactivant et en retournant un résultat facultatif au parent du dialogue. |
| Dialog |
findDialog(String dialogId)
Recherchez l’ID de boîte de dialogue pour le contexte donné. |
|
Dialog |
getActiveDialog()
Obtient l’instance mise en cache de la boîte de dialogue active en haut de la pile ou null si la pile est vide. |
|
Dialog |
getChild()
Obtient le contexte de boîte de dialogue pour enfant s’il existe un enfant actif. |
|
Turn |
getContext()
Obtient le contexte du tour de conversation actuel. |
|
Dialog |
getDialogs()
Obtient l’ensemble de dialogues actifs pour le conteneur de dialogues actuel. |
| java.lang.String |
getLocale()
Obtenez les paramètres régionaux dans la boîte de dialogue |
|
Dialog |
getParent()
Obtient la boîte de dialogue parente |
|
Turn |
getServices()
Obtient la collection de services contextuelle à ce contexte de dialogue. |
|
java.util.List<Dialog |
getStack()
Obtient la pile de dialogues actuelle. |
|
Dialog |
getState()
Obtient ou définit la boîte de dialogue |
|
java.util.concurrent.CompletableFuture<Dialog |
prompt(String dialogId, PromptOptions options)
Fonction d’assistance pour simplifier la mise en forme des options d’appel d’une boîte de dialogue d’invite. |
|
java.util.concurrent.CompletableFuture<Dialog |
replaceDialog(String dialogId)
Méthode d’assistance pour replaceDialog(String dialogId, Object options) qui passe null pour les options. |
|
java.util.concurrent.CompletableFuture<Dialog |
replaceDialog(String dialogId, Object options)
Démarre une nouvelle boîte de dialogue et remplace la pile par la nouvelle boîte de dialogue active. |
| java.util.concurrent.CompletableFuture<java.lang.Void> |
repromptDialog()
Appelle la méthode repromptDialog(TurnContext turnContext, DialogInstance instance) de la boîte de dialogue active. |
| void |
setParent(DialogContext withDialogContext)
Définissez la boîte de dialogue parente |
Méthodes héritées de java.lang.Object
Détails du constructeur
DialogContext
public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)
Initialise une nouvelle instance de la classe DialogContext à partir du contexte de tour.
Paramètres:
DialogContext
public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)
Initialise une nouvelle instance de la classe DialogContext à partir du contexte de tour.
Paramètres:
Détails de la méthode
beginDialog
public CompletableFuture
Démarre un nouveau dialogue et l’envoie (push) sur la pile de dialogues.
Paramètres:
Retours:
beginDialog
public CompletableFuture
Démarre un nouveau dialogue et l’envoie (push) sur la pile de dialogues.
Paramètres:
Retours:
cancelAllDialogs
public CompletableFuture
Méthode d’assistance pour cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) qui n’annule pas les dialogues parents ou passe et l’événement.
Retours:
cancelAllDialogs
public CompletableFuture
Supprime toute pile de dialogues existante, ce qui annule tous les dialogues de la pile.
En règle générale, le contexte parent est le gestionnaire de tour de dialogue ou de bot qui a démarré le dialogue. Si le parent est un dialogue, la pile appelle la méthode resumeDialog(DialogContext dc, DialogReason reason, Object result) du parent pour retourner un résultat au dialogue parent. Si la boîte de dialogue parent n’implémente pas Dialog#resumeDialog, le parent se termine également et le résultat est passé au contexte parent suivant.
Paramètres:
Retours:
continueDialog
public CompletableFuture
Poursuit l’exécution du dialogue actif, s’il en existe un, en passant le DialogContext actuel à la méthode de continueDialog(DialogContext dc) du dialogue actif.
Retours:
emitEvent
public CompletableFuture
Paramètres:
Retours:
emitEvent
public CompletableFuture
Paramètres:
true.
Retours:
endDialog
public CompletableFuture
Méthode d’assistance qui fournit un résultat Null à endDialog(Object result).
Retours:
endDialog
public CompletableFuture
Termine une boîte de dialogue en la désactivant et en retournant un résultat facultatif au parent du dialogue. La boîte de dialogue parente est la boîte de dialogue démarrée par le biais d’un appel à beginDialog(String dialogId, Object options) ou prompt(String dialogId, PromptOptions options). La boîte de dialogue parent aura son resumeDialog(DialogContext dc, DialogReason reason, Object result) méthode appelée avec n’importe quel résultat retourné. Si la boîte de dialogue parent n’a pas implémenté de méthode resumeDialog(DialogContext dc, DialogReason reason), elle est automatiquement terminée et le résultat transmis à son parent. S’il n’y a plus de dialogues parents sur la pile, le traitement du tour se termine.
Paramètres:
Retours:
findDialog
public Dialog findDialog(String dialogId)
Recherchez l’ID de boîte de dialogue pour le contexte donné.
Paramètres:
Retours:
getActiveDialog
public DialogInstance getActiveDialog()
Obtient l’instance mise en cache de la boîte de dialogue active en haut de la pile ou null si la pile est vide.
Retours:
getChild
public DialogContext getChild()
Obtient le contexte de boîte de dialogue pour enfant s’il existe un enfant actif.
Retours:
getContext
public TurnContext getContext()
Obtient le contexte du tour de conversation actuel.
Retours:
getDialogs
public DialogSet getDialogs()
Obtient l’ensemble de dialogues actifs pour le conteneur de dialogues actuel.
Retours:
getLocale
public String getLocale()
Obtenez les paramètres régionaux dans DialogContext.
Retours:
getParent
public DialogContext getParent()
Obtient le dialogContext parent, le cas échéant. Utilisé lors de la recherche de l’ID d’une boîte de dialogue à démarrer.
Retours:
getServices
public TurnContextStateCollection getServices()
Obtient la collection de services contextuelle à ce contexte de dialogue.
Retours:
getStack
public List
Obtient la pile de dialogues actuelle.
Retours:
getState
public DialogStateManager getState()
Obtient ou définit le DialogStateManager qui gère l’affichage de toutes les étendues de mémoire.
Retours:
prompt
public CompletableFuture
Fonction d’assistance pour simplifier la mise en forme des options d’appel d’une boîte de dialogue d’invite. Cet assistance prend un argument PromptOptions, puis appelle beginDialog(String dialogId, Object options)
Paramètres:
Retours:
replaceDialog
public CompletableFuture
Méthode d’assistance pour replaceDialog(String dialogId, Object options) qui passe null pour les options.
Paramètres:
Retours:
replaceDialog
public CompletableFuture
Démarre une nouvelle boîte de dialogue et remplace la pile par la nouvelle boîte de dialogue active. Cela est particulièrement utile pour créer des boucles ou rediriger vers un autre dialogue.
Paramètres:
Retours:
repromptDialog
public CompletableFuture
Appelle la méthode repromptDialog(TurnContext turnContext, DialogInstance instance) de la boîte de dialogue active. Utilisé avec des dialogues qui implémentent un comportement de nouvelle invite.
Retours:
setParent
public void setParent(DialogContext withDialogContext)
Définissez le dialogContext parent.
Paramètres: