DialogContext Classe

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

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 DialogContext à partir du contexte de tour.

DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

Initialise une nouvelle instance de la classe DialogContext à partir du contexte de tour.

Résumé de la méthode

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

Démarre un nouveau dialogue et l’envoie (push) sur la pile de dialogues.

java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(String dialogId, Object options)

Démarre un nouveau dialogue et l’envoie (push) sur la pile de dialogues.

java.util.concurrent.CompletableFuture<DialogTurnResult> 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<DialogTurnResult> 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<DialogTurnResult> continueDialog()

Poursuit l’exécution du dialogue actif, s’il en existe un, en transmettant le contextedialogue actuel à la méthode continueDialog(DialogContext dc) du dialogue actif.

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<DialogTurnResult> endDialog()

Méthode d’assistance qui fournit un résultat Null à endDialog(Object result).

java.util.concurrent.CompletableFuture<DialogTurnResult> 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é.

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.

DialogContext getChild()

Obtient le contexte de boîte de dialogue pour enfant s’il existe un enfant actif.

TurnContext getContext()

Obtient le contexte du tour de conversation actuel.

DialogSet 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 dialoguecontexte.

DialogContext getParent()

Obtient la boîte de dialogue parentecontexte, le cas échéant.

TurnContextStateCollection getServices()

Obtient la collection de services contextuelle à ce contexte de dialogue.

java.util.List<DialogInstance> getStack()

Obtient la pile de dialogues actuelle.

DialogStateManager getState()

Obtient ou définit la boîte de dialogue'étatManager qui gère l’affichage de toutes les étendues de mémoire.

java.util.concurrent.CompletableFuture<DialogTurnResult> 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<DialogTurnResult> replaceDialog(String dialogId)

Méthode d’assistance pour replaceDialog(String dialogId, Object options) qui passe null pour les options.

java.util.concurrent.CompletableFuture<DialogTurnResult> 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 parentecontexte.

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

DialogContext

public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)

Initialise une nouvelle instance de la classe DialogContext à partir du contexte de tour.

Paramètres:

withDialogs - La boîte de dialogue définie pour créer le contexte de dialogue.
withTurnContext - Contexte de tour actuel.
withState - Propriété d’état à partir de laquelle récupérer le contexte de boîte de dialogue.

DialogContext

public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

Initialise une nouvelle instance de la classe DialogContext à partir du contexte de tour.

Paramètres:

withDialogs - La boîte de dialogue définie pour créer le contexte de dialogue.
withParentDialogContext - Contexte de boîte de dialogue parent.
withState - État actuel de la boîte de dialogue.

Détails de la méthode

beginDialog

public CompletableFuture beginDialog(String dialogId)

Démarre un nouveau dialogue et l’envoie (push) sur la pile de dialogues.

Paramètres:

dialogId - ID de la boîte de dialogue à démarrer.

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 CompletableFuture beginDialog(String dialogId, Object options)

Démarre un nouveau dialogue et l’envoie (push) sur la pile de dialogues.

Paramètres:

dialogId - ID de la boîte de dialogue à démarrer.
options - Facultatif, informations à transmettre au dialogue en cours de démarrage.

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.

cancelAllDialogs

public CompletableFuture 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.

Retours:

Si la tâche réussit, le résultat indique que les dialogues ont été annulés après le traitement du tour par la boîte de dialogue ou que la pile était déjà vide.

cancelAllDialogs

public CompletableFuture cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)

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:

cancelParents - Si la valeur true, l’annulation se déclenche également par le biais de dialogues parents.
eventName - Événement. Si la valeur est Null, CANCEL_DIALOG est utilisée.
eventValue - Valeur de l’événement. Peut être null.

Retours:

Si la tâche réussit, le résultat indique que les dialogues ont été annulés après le traitement du tour par la boîte de dialogue ou que la pile était déjà vide.

continueDialog

public CompletableFuture continueDialog()

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:

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.

emitEvent

public CompletableFuture emitEvent(String name)

Paramètres:

name - Nom de l’événement à déclencher.

Retours:

emitEvent

emitEvent

public CompletableFuture emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)

Paramètres:

name - Nom de l’événement à déclencher.
value - Valeur à envoyer avec l’événement.
bubble - Indicateur pour contrôler si l’événement doit être en bulles à son parent s’il n’est pas géré localement. La valeur par défaut est true.
fromLeaf - Indique si l’événement est émis à partir d’un nœud feuille.

Retours:

completedFuture

endDialog

public CompletableFuture endDialog()

Méthode d’assistance qui fournit un résultat Null à endDialog(Object result).

Retours:

Si la tâche réussit, le résultat indique que le dialogue s’est terminé après le traitement du tour par la boîte de dialogue.

endDialog

public CompletableFuture endDialog(Object result)

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:

result - Facultatif, résultat à passer au contexte parent.

Retours:

Si la tâche réussit, le résultat indique que le dialogue s’est terminé après le traitement du tour par la boîte de dialogue.

findDialog

public Dialog findDialog(String dialogId)

Recherchez l’ID de boîte de dialogue pour le contexte donné.

Paramètres:

dialogId - ID de boîte de dialogue à rechercher.

Retours:

boîte de dialogue avec cet ID ou null.

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:

Instance mise en cache de la boîte de dialogue active en haut de la pile ou null si la pile est vide.

getChild

public DialogContext getChild()

Obtient le contexte de boîte de dialogue pour enfant s’il existe un enfant actif.

Retours:

Contexte de boîte de dialogue pour enfant s’il existe un enfant actif.

getContext

public TurnContext getContext()

Obtient le contexte du tour de conversation actuel.

Retours:

Contexte du tour de conversation actuel.

getDialogs

public DialogSet getDialogs()

Obtient l’ensemble de dialogues actifs pour le conteneur de dialogues actuel.

Retours:

Ensemble de dialogues actifs pour le conteneur de dialogues actuel.

getLocale

public String getLocale()

Obtenez les paramètres régionaux dans DialogContext.

Retours:

Chaîne représentant les paramètres régionaux actuels.

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:

Parent « DialogContext, le cas échéant. Utilisé lors de la recherche de l’ID d’une boîte de dialogue à démarrer.

getServices

public TurnContextStateCollection getServices()

Obtient la collection de services contextuelle à ce contexte de dialogue.

Retours:

Collection de services.

getStack

public List getStack()

Obtient la pile de dialogues actuelle.

Retours:

Pile de dialogues actuelle.

getState

public DialogStateManager getState()

Obtient ou définit le DialogStateManager qui gère l’affichage de toutes les étendues de mémoire.

Retours:

DialogStateManager avec vue de mémoire unifiée de toutes les étendues de mémoire.

prompt

public CompletableFuture 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. Cet assistance prend un argument PromptOptions, puis appelle beginDialog(String dialogId, Object options)

Paramètres:

dialogId - ID de la boîte de dialogue d’invite à démarrer.
options - Informations à transmettre à la boîte de dialogue d’invite en cours de démarrage.

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.

replaceDialog

public CompletableFuture replaceDialog(String dialogId)

Méthode d’assistance pour replaceDialog(String dialogId, Object options) qui passe null pour les options.

Paramètres:

dialogId - ID de la nouvelle boîte de dialogue à démarrer.

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.

replaceDialog

public CompletableFuture 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. Cela est particulièrement utile pour créer des boucles ou rediriger vers un autre dialogue.

Paramètres:

dialogId - ID de la nouvelle boîte de dialogue à démarrer.
options - Facultatif, informations à transmettre au dialogue en cours de démarrage.

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.

repromptDialog

public CompletableFuture repromptDialog()

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:

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

setParent

public void setParent(DialogContext withDialogContext)

Définissez le dialogContext parent.

Paramètres:

withDialogContext - DialogContext sur lequel définir le parent.

S’applique à