DialogContainer Classe

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

public abstract class DialogContainer
extends Dialog

Conteneur pour un ensemble de dialogues.

Récapitulatif du constructeur

Constructeur Description
DialogContainer()

Crée une instance avec l’ID de boîte de dialogue par défaut.
DialogContainer(String dialogId)

Crée une instance avec l’ID de boîte de dialogue par défaut.

Résumé de la méthode

Modificateur et type Méthode et description
protected java.util.concurrent.CompletableFuture<java.lang.Void> checkForVersionChange(DialogContext dc)

Vérifie si les dialogues enfants d’un conteneur ont changé depuis le démarrage de l’instance de dialogue actuelle.
abstract DialogContext createChildContext(DialogContext dc)

Crée un contexte de dialogue interne pour les conteneurs actifs enfants.
Dialog findDialog(String dialogId)

Recherche dans la boîte de dialogue actuelledéfinir un dialogue par son ID.
DialogSet getDialogs()

Retourne les dialogues sous la forme d’un jeu de dialogues.
protected java.lang.String getInternalVersion()

Retourne l’identificateur de version interne pour ce conteneur.
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é.
void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Définit le botTélémétrieClient à utiliser pour la journalisation.

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

DialogContainer

public DialogContainer()

Crée une instance avec l’ID de boîte de dialogue par défaut.

DialogContainer

public DialogContainer(String dialogId)

Crée une instance avec l’ID de boîte de dialogue par défaut.

Paramètres:

dialogId - ID de la boîte de dialogue.

Détails de la méthode

checkForVersionChange

protected CompletableFuture checkForVersionChange(DialogContext dc)

Vérifie si les dialogues enfants d’un conteneur ont changé depuis le démarrage de l’instance de dialogue actuelle. Cela doit être appelé au début de ' beginDialog()', 'continueDialog()' et 'resumeDialog()'.

Paramètres:

dc - contexte de boîte de dialogue

Retours:

CompletableFuture

createChildContext

public abstract DialogContext createChildContext(DialogContext dc)

Crée un contexte de dialogue interne pour les conteneurs actifs enfants.

Paramètres:

dc - Contexte de dialogue Parents.

Retours:

Nouveau contexte de dialogue pour l’enfant actif.

findDialog

public Dialog findDialog(String dialogId)

Recherche dans l’ensemble de dialogues actuel un dialogue par son ID.

Paramètres:

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

Retours:

Boîte de dialogue s’il est trouvé ; sinon, null

getDialogs

public DialogSet getDialogs()

Retourne les boîtes de dialogue en tant qu’ensemble de dialogues.

Retours:

Ensemble de dialogues.

getInternalVersion

protected String getInternalVersion()

Retourne l’identificateur de version interne pour ce conteneur.

DialogContainers détecte les modifications de tous les sous-composants du conteneur et mappez-les à un événement DialogChanged. Comme ils le font, DialogContainers « masque » les modifications internes et ont simplement le fichier .id. Cela isole les modifications apportées au niveau du conteneur, sauf si un conteneur ne le gère pas. Pour prendre en charge ce DialogContainers, définissez une méthode virtuelle protégée getInternalVersion() qui calcule si cette boîte de dialogue ou dialogue enfant a changé, qui est ensuite examinée via des appels à checkForVersionChange().

Retours:

version qui représente la modification des éléments internes de ce conteneur.

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é.

Cette substitution trace les modifications de version.

Remplacements:

DialogContainer.onDialogEvent(DialogContext dc, DialogEvent e)

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.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Définit BotTelemetryClient à utiliser pour la journalisation. Lors de la définition de cette propriété, toutes les propriétés BotTelemetryClient des boîtes de dialogue contenues sont également définies.

Remplacements:

DialogContainer.setTelemetryClient(BotTelemetryClient withTelemetryClient)

Paramètres:

withTelemetryClient - BotTelemetryClient à utiliser pour la journalisation.

S’applique à