Dialog Klasse

  • Referenz
Paket:
com.microsoft.bot.dialogs
Maven-Artefakt:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.Dialog

public abstract class Dialog

Basisklasse für alle Dialogfelder.

Feldzusammenfassung

Modifizierer und Typ Feld und Beschreibung
static final DialogTurnResult END_OF_TURN

Ein DialogTurnResult, der angibt, dass das aktuelle Dialogfeld noch aktiv ist und auf Eingaben des Benutzers wartet.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
Dialog(String dialogId)

Initialisiert eine neue Instanz der Dialog-Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc)

Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.
abstract java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Wird aufgerufen, wenn das Dialogfeld _fortsetzung_ ist, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Wird aufgerufen, wenn das Dialogfeld beendet wird.
java.lang.String getId()

Ruft die ID für das Dialogfeld ab.
BotTelemetryClient getTelemetryClient()

Ruft die für die Protokollierung zu verwendende BotTelemetryClient ab.
java.lang.String getVersion()

Ruft eine eindeutige Zeichenfolge, die die Version dieses Dialogfelds darstellt.
protected static java.util.concurrent.CompletableFuture<DialogTurnResult> innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Gemeinsame Implementierung der Ausführung mit Dialog und DialogManager.
protected java.lang.String onComputeId()

Berechnet eine ID für das Dialogfeld.
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.
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPostBubbleEvent(DialogContext dc, DialogEvent e)

Wird aufgerufen, nachdem ein Ereignis für alle übergeordneten Eltern eingeblasen wurde und nicht behandelt wurde.
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

Wird aufgerufen, bevor ein Ereignis in das übergeordnete Element eingeblasen wird.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Wird aufgerufen, wenn das Dialogfeld den Benutzer zur Eingabe erneut auffordert.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason)

Wird aufgerufen, wenn ein untergeordnetes Dialogfeld diesen Vorgang abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Wird aufgerufen, wenn ein untergeordnetes Dialogfeld diesen Vorgang abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.
static java.util.concurrent.CompletableFuture<java.lang.Void> run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor<DialogState> accessor)

Erstellt einen Dialogstapel und startet ein Dialogfeld, indem es auf den Stapel verschoben wird.
void setId(String withId)

Legt die ID für das Dialogfeld fest.
void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Legt den BotTelemetryClient fest, der für die Protokollierung verwendet werden soll.

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

Felddetails

END_OF_TURN

public static final DialogTurnResult END_OF_TURN

Ein DialogTurnResult, der angibt, dass das aktuelle Dialogfeld noch aktiv ist und auf Eingaben des Benutzers wartet.

Details zum Konstruktor

Dialog

public Dialog(String dialogId)

Initialisiert eine neue Instanz der Dialog-Klasse.

Parameter:

dialogId - Die ID, die diesem Dialogfeld zugewiesen werden soll.

Details zur Methode

beginDialog

public CompletableFuture beginDialog(DialogContext dc)

Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.

Parameter:

dc - Die DialogContext für die aktuelle Unterhaltungswende.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

beginDialog

public abstract CompletableFuture beginDialog(DialogContext dc, Object options)

Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.

Parameter:

dc - Die DialogContext für die aktuelle Unterhaltungswende.
options - Anfängliche Informationen, die an das Dialogfeld übergeben werden sollen.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

Wird aufgerufen, wenn das Dialogfeld _fortsetzung_ ist, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.

Wenn diese Methode *nicht* überschrieben ist, wird das Dialogfeld automatisch beendet, wenn der Benutzer antwortet.

Parameter:

dc - Die DialogContext für die aktuelle Unterhaltungswende.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob das Dialogfeld noch aktiv ist, nachdem die Drehung vom Dialogfeld verarbeitet wurde. Das Ergebnis kann auch einen Rückgabewert enthalten.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Wird aufgerufen, wenn das Dialogfeld beendet wird.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.
instance - Statusinformationen, die der Instanz dieses Dialogfelds im Dialogstapel zugeordnet sind.
reason - Grund, warum das Dialogfeld beendet wurde.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

getId

public String getId()

Ruft die ID für das Dialogfeld ab.

Gibt zurück:

ID für das Dialogfeld.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Ruft die für die Protokollierung zu verwendende BotTelemetryClient ab.

Gibt zurück:

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

getVersion

public String getVersion()

Ruft eine eindeutige Zeichenfolge, die die Version dieses Dialogfelds darstellt. Wenn sich die Version ändert, gibt das Dialogfeldsystem ein DialogChanged-Ereignis aus.

Gibt zurück:

Eindeutige Zeichenfolge, die sich nur ändern sollte, wenn sich das Dialogfeld so geändert hat, dass das Dialogfeld neu gestartet werden soll.

innerRun

protected static CompletableFuture innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Gemeinsame Implementierung der Ausführung mit Dialog und DialogManager.

Parameter:

turnContext - Der turnContext.
dialogId - Die ID des Dialogfelds.
dialogContext - The DialogContext.
stateConfiguration - The DialogStateManagerConfiguration.

Gibt zurück:

Ein DialogTurnResult.

onComputeId

protected String onComputeId()

Berechnet eine ID für das Dialogfeld.

Gibt zurück:

Die ID.

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.

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.

onPostBubbleEvent

protected CompletableFuture onPostBubbleEvent(DialogContext dc, DialogEvent e)

Wird aufgerufen, nachdem ein Ereignis für alle übergeordneten Eltern eingeblasen wurde und nicht behandelt wurde.

Dies ist ein guter Ort, um Standardverarbeitungslogik für ein Ereignis auszuführen. Das Zurückgeben von "true" verhindert die Verarbeitung des Ereignisses durch untergeordnete Dialogfelder.

Parameter:

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

Gibt zurück:

Gibt an, ob das Ereignis vom aktuellen Dialogfeld behandelt wird und die weitere Verarbeitung beendet werden soll.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

Wird aufgerufen, bevor ein Ereignis in das übergeordnete Element eingeblasen wird.

Dies ist ein guter Ort, um das Abfangen eines Ereignisses durchzuführen, da das Zurückgeben von "true" eine weitere Bubbling des Ereignisses an die übergeordneten Dialoge verhindert und auch verhindert, dass untergeordnete Dialogfelder ihre Standardverarbeitung ausführen.

Parameter:

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

Gibt zurück:

Gibt an, ob das Ereignis vom aktuellen Dialogfeld behandelt wird und die weitere Verarbeitung beendet werden soll.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

Wird aufgerufen, wenn das Dialogfeld den Benutzer zur Eingabe erneut auffordert.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.
instance - Statusinformationen für dieses Dialogfeld.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason)

Wird aufgerufen, wenn ein untergeordnetes Dialogfeld diesen Vorgang abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

Im Allgemeinen wurde das untergeordnete Dialogfeld mit einem Aufruf von beginDialog(DialogContext dc, Object options) Gestartet. Wenn die replaceDialog(String dialogId)-Methode aufgerufen wird, kann sich das logische untergeordnete Dialogfeld vom Ursprünglichen unterscheiden.

Wenn diese Methode *nicht* überschrieben ist, wird das Dialogfeld automatisch beendet, wenn der Benutzer antwortet.

Parameter:

dc - Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.
reason - Grund, warum das Dialogfeld fortgesetzt wurde.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob dieses Dialogfeld nach der Verarbeitung dieses Dialogfelds noch aktiv ist.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

Wird aufgerufen, wenn ein untergeordnetes Dialogfeld diesen Vorgang abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

Im Allgemeinen wurde das untergeordnete Dialogfeld mit einem Aufruf von beginDialog(DialogContext dc, Object options) Gestartet. Wenn die replaceDialog(String dialogId, Object options)-Methode aufgerufen wird, kann sich das logische untergeordnete Dialogfeld vom Ursprünglichen unterscheiden.

Wenn diese Methode *nicht* überschrieben ist, wird das Dialogfeld automatisch beendet, wenn der Benutzer antwortet.

Parameter:

dc - Der Dialogfeldkontext für die aktuelle Drehung der Unterhaltung.
reason - Grund, warum das Dialogfeld fortgesetzt wurde.
result - Optionaler Wert, der aus dem aufgerufenen Dialogfeld zurückgegeben wurde. Der Typ des zurückgegebenen Werts hängt vom untergeordneten Dialogfeld ab.

Gibt zurück:

Wenn die Aufgabe erfolgreich ist, gibt das Ergebnis an, ob dieses Dialogfeld nach der Verarbeitung dieses Dialogfelds noch aktiv ist.

run

public static CompletableFuture run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor accessor)

Erstellt einen Dialogstapel und startet ein Dialogfeld, indem es auf den Stapel verschoben wird.

Parameter:

dialog - Das Dialogfeld, das gestartet werden soll.
turnContext - Der Kontext für die aktuelle Drehung der Unterhaltung.
accessor - Der StatePropertyAccessor-Accessor, mit dem der Status des Dialogfeldstapels verwaltet werden soll.

Gibt zurück:

Eine Aufgabe, die den asynchronen Vorgang darstellt.

setId

public void setId(String withId)

Legt die ID für das Dialogfeld fest.

Parameter:

withId - ID für das Dialogfeld.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Legt den BotTelemetryClient fest, der für die Protokollierung verwendet werden soll.

Parameter:

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

Gilt für: