WaterfallDialog Klasse

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

public class WaterfallDialog
extends Dialog

Dialogfeld, das für die Aufforderung eines Benutzers mit einer Reihe von Fragen optimiert ist. Wasserfälle akzeptieren einen Stapel von Funktionen, die in Folge ausgeführt werden. Jeder Wasserfallschritt kann eine Frage des Benutzers stellen, und die Antwort des Benutzers wird als Argument an den nächsten Wasserfallschritt übergeben.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
WaterfallDialog(String dialogId, List<WaterfallStep> actions)

Initialisiert eine neue Instanz der WaterfallDialog Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
WaterfallDialog addStep(WaterfallStep step)

Fügt dem Wasserfall einen neuen Schritt hinzu.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

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

Wird aufgerufen, wenn das Wasserfalldialogfeld _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 getVersion()

Ruft eine eindeutige Zeichenfolge, die die Version dieses Dialogfelds darstellt.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onStep(WaterfallStepContext stepContext)

Wird aufgerufen, wenn ein einzelner Wasserfallschritt ausgeführt wird.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Wird aufgerufen, wenn ein untergeordnetes Wasserfalldialogfeld seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> runStep(DialogContext dc, int index, DialogReason reason, Object result)

Erregt einen Schritt des Wasserfalldialogs.

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

WaterfallDialog

public WaterfallDialog(String dialogId, List actions)

Initialisiert eine neue Instanz der WaterfallDialog Klasse.

Parameter:

dialogId - Die Dialogfeld-ID.
actions - Optionale Aktionen, die vom Aufrufer definiert werden sollen.

Details zur Methode

addStep

public WaterfallDialog addStep(WaterfallStep step)

Fügt dem Wasserfall einen neuen Schritt hinzu.

Parameter:

step - Schritt zum Hinzufügen.

Gibt zurück:

Wasserfalldialogfeld für Fluent-Anrufe an AddStep().

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

Wird aufgerufen, wenn das Wasserfalldialogfeld gestartet und auf den Dialogstapel verschoben wird.

Überschreibt:

WaterfallDialog.beginDialog(DialogContext dc, Object options)

Parameter:

dc - Das
options - Optional, erste Informationen, die an das Dialogfeld übergeben werden sollen.

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

Überschreibt:

WaterfallDialog.continueDialog(DialogContext dc)

Parameter:

dc - Das

Gibt zurück:

Eine CompletableFuture, die den asynchronen Vorgang darstellt. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value.

endDialog

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

Wird aufgerufen, wenn das Dialogfeld beendet wird.

Überschreibt:

WaterfallDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Parameter:

turnContext - Kontext für die aktuelle Drehung der Unterhaltung.
instance - Die Instanz des aktuellen Dialogfelds.
reason - Der Grund, warum das Dialogfeld beendet wird.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

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.

Überschreibt:

WaterfallDialog.getVersion()

Gibt zurück:

Die Version ändert sich, wenn sich die Anzahl der Schritte ändert (da das Dialogfeld keine Möglichkeit hat, den Inhalt der Schritte auszuwerten.

onStep

protected CompletableFuture onStep(WaterfallStepContext stepContext)

Wird aufgerufen, wenn ein einzelner Wasserfallschritt ausgeführt wird.

Parameter:

stepContext - Kontext für den auszuführenden Wasserfallschritt.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

resumeDialog

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

Wird aufgerufen, wenn ein untergeordnetes Wasserfalldialogfeld seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

Überschreibt:

WaterfallDialog.resumeDialog(DialogContext dc, DialogReason reason, Object result)

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:

Eine CompletableFuture, die den asynchronen Vorgang darstellt.

runStep

protected CompletableFuture runStep(DialogContext dc, int index, DialogReason reason, Object result)

Erregt einen Schritt des Wasserfalldialogs.

Parameter:

dc - Die DialogContext für die aktuelle Unterhaltungswende.
index - Der Index des aktuellen Wasserfallschritts, der ausgeführt werden soll.
reason - Der Grund, warum der Wasserfallschritt ausgeführt wird.
result - Ergebnis, das von einem Dialogfeld zurückgegeben wird, das im vorherigen Wasserfallschritt aufgerufen wird.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

Gilt für: