DialogContainer Klasse

  • Referenz
Paket:
com.microsoft.bot.dialogs
Maven-Artefakt:
com.microsoft.bot:bot-dialogs:4.14.3

public abstract class DialogContainer
extends Dialog

Ein Container für eine Reihe von Dialogfeldern.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
DialogContainer()

Erstellt eine neue Instanz mit der Standarddialog-ID.
DialogContainer(String dialogId)

Erstellt eine neue Instanz mit der Standarddialog-ID.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
protected java.util.concurrent.CompletableFuture<java.lang.Void> checkForVersionChange(DialogContext dc)

Überprüft, ob sich ein untergeordnetes Containerdialogfeld seit dem Start der aktuellen Dialoginstanz geändert hat.
abstract DialogContext createChildContext(DialogContext dc)

Erstellt einen inneren Dialogkontext für die Container, die untergeordnete Container sind.
Dialog findDialog(String dialogId)

Durchsucht das aktuelle DialogfeldNach einem Dialogfeld anhand seiner ID festlegen.
DialogSet getDialogs()

Gibt die Dialogfelder als DialogfeldFestlegen zurück.
protected java.lang.String getInternalVersion()

Gibt den internen Versionsbezeichner für diesen Container zurück.
java.util.concurrent.CompletableFuture<java.lang.Boolean> onDialogEvent(DialogContext dc, DialogEvent e)

Wird aufgerufen, wenn ein Ereignis ausgelöst wurde, unter Verwendung von "DialogKontext".Event()' aus, entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das das aktuelle Dialogfeld gestartet hat.
void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Legt den Bot-Telemetrie-Client fest, der für die Protokollierung verwendet werden soll.

Geerbte Methoden von Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

Geerbte Methoden von 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

Details zum Konstruktor

DialogContainer

public DialogContainer()

Erstellt eine neue Instanz mit der Standarddialog-ID.

DialogContainer

public DialogContainer(String dialogId)

Erstellt eine neue Instanz mit der Standarddialog-ID.

Parameter:

dialogId - ID des Dialogfelds.

Details zur Methode

checkForVersionChange

protected CompletableFuture checkForVersionChange(DialogContext dc)

Überprüft, ob sich ein untergeordnetes Containerdialogfeld seit dem Start der aktuellen Dialoginstanz geändert hat. Dies sollte am Anfang von "beginDialog()", "continueDialog()" und "resumeDialog()" aufgerufen werden.

Parameter:

dc - Dialogkontext

Gibt zurück:

CompletableFuture

createChildContext

public abstract DialogContext createChildContext(DialogContext dc)

Erstellt einen inneren Dialogkontext für die Container, die untergeordnete Container sind.

Parameter:

dc - Kontext des Dialogfelds "Eltern".

Gibt zurück:

Ein neuer Dialogfeldkontext für das aktive untergeordnete Element.

findDialog

public Dialog findDialog(String dialogId)

Durchsucht das aktuelle DialogSet nach einem Dialogfeld anhand seiner ID.

Parameter:

dialogId - ID des dialogfelds, nach dem gesucht werden soll.

Gibt zurück:

Das Dialogfeld, falls gefunden; andernfalls NULL

getDialogs

public DialogSet getDialogs()

Gibt die Dialoge als DialogSet zurück.

Gibt zurück:

Das DialogSet von Dialogfeldern.

getInternalVersion

protected String getInternalVersion()

Gibt den internen Versionsbezeichner für diesen Container zurück.

DialogContainers erkennen Änderungen aller Unterkomponenten im Container und ordnen diese einem DialogChanged-Ereignis zu. Da dies der Fall ist, blendet DialogContainer die internen Änderungen aus und hat lediglich die ID. Dadurch werden Änderungen auf der Containerebene isoliert, es sei denn, ein Container behandelt sie nicht. Um diese DialogContainers zu unterstützen, definieren Sie eine geschützte virtuelle Methode getInternalVersion(), die berechnet, ob sich dieses Dialogfeld oder untergeordnete Dialogfeld geändert hat, das dann über Aufrufe von checkForVersionChange() untersucht wird.

Gibt zurück:

version which represents the change of the internals of this container.

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

Wird aufgerufen, wenn ein Ereignis ausgelöst wurde, mithilfe von "DialogContext.emitEvent()", entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das das aktuelle Dialogfeld gestartet hat.

Diese Außerkraftsetzung verfolgt Versionsänderungen.

Überschreibt:

DialogContainer.onDialogEvent(DialogContext dc, DialogEvent e)

Parameter:

dc - Der Dialogkontext für die aktuelle Unterhaltungswende.
e - Das ausgelöste Ereignis.

Gibt zurück:

True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und Bubbling beendet werden soll.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Legt den Für die Protokollierung zu verwendenden BotTelemetryClient fest. Beim Festlegen dieser Eigenschaft werden auch alle enthaltenen BotTelemetryClient-Eigenschaften festgelegt.

Überschreibt:

DialogContainer.setTelemetryClient(BotTelemetryClient withTelemetryClient)

Parameter:

withTelemetryClient - Der BotTelemetryClient, der für die Protokollierung verwendet werden soll.

Gilt für: