WaterfallStepContext Klasse

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

public class WaterfallStepContext
extends DialogContext

Stellt kontext für einen Schritt in einem WaterfallDialog bereit. Die DialogContext-Eigenschaft enthält die TurnContext für die aktuelle Drehung.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
WaterfallStepContext(WaterfallDialog parentWaterfall, DialogContext dc, Object options, Map<String,Object> values, int index, DialogReason reason, Object result)

Initialisiert eine neue Instanz der WaterfallStepContext Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
int getIndex()

Ruft den Index des aktuellen Wasserfallschritts ab, der ausgeführt wird.
java.lang.Object getOptions()

Ruft alle Optionen ab, mit der das Wasserfalldialogfeld aufgerufen wurde.
DialogReason getReason()

Ruft den Grund ab, warum der Wasserfallschritt ausgeführt wird.
java.lang.Object getResult()

Ruft das Ergebnis aus dem vorherigen Wasserfallschritt ab.
java.util.Map<java.lang.String,java.lang.Object> getValues()

Ruft ein Wörterbuch mit Werten ab, das über alle Wasserfallaktionen hinweg beibehalten wird.
java.util.concurrent.CompletableFuture<DialogTurnResult> next(Object result)

Springt zum nächsten Schritt des Wasserfalls.

Geerbte Methoden von DialogContext

beginDialog beginDialog cancelAllDialogs cancelAllDialogs continueDialog emitEvent emitEvent endDialog endDialog findDialog getActiveDialog getChild getContext getDialogs getLocale getParent getServices getStack getState prompt replaceDialog replaceDialog repromptDialog setParent

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

WaterfallStepContext

public WaterfallStepContext(WaterfallDialog parentWaterfall, DialogContext dc, Object options, Map values, int index, DialogReason reason, Object result)

Initialisiert eine neue Instanz der WaterfallStepContext Klasse.

Parameter:

parentWaterfall - Das übergeordnete Element des Wasserfalldialogfelds.
dc - Der Kontext des Dialogfelds.
options - Alle Optionen zum Aufrufen des Wasserfalldialogfelds
values - Ein Wörterbuch mit Werten, das in allen Wasserfallschritten beibehalten wird.
index - Der Index des auszuführenden aktuellen Wasserfalls.
reason - Der Grund, warum der Wasserfallschritt ausgeführt wird.
result - Ergebnisse, die von einem Dialogfeld zurückgegeben werden, das im vorherigen Wasserfallschritt aufgerufen wird.

Details zur Methode

getIndex

public int getIndex()

Ruft den Index des aktuellen Wasserfallschritts ab, der ausgeführt wird.

Gibt zurück:

gibt den Indexwert zurück;

getOptions

public Object getOptions()

Ruft alle Optionen ab, mit der das Wasserfalldialogfeld aufgerufen wurde.

Gibt zurück:

Die Optionen.

getReason

public DialogReason getReason()

Ruft den Grund ab, warum der Wasserfallschritt ausgeführt wird.

Gibt zurück:

The DialogReason

getResult

public Object getResult()

Ruft das Ergebnis aus dem vorherigen Wasserfallschritt ab. Das Ergebnis ist häufig der Rückgabewert eines untergeordneten Dialogfelds, das im vorherigen Schritt des Wasserfalls gestartet wurde.

Gibt zurück:

den Ergebniswert.

getValues

public Map getValues()

Ruft ein Wörterbuch mit Werten ab, das über alle Wasserfallaktionen hinweg beibehalten wird.

Gibt zurück:

Das Wörterbuch der Werte.

next

public CompletableFuture next(Object result)

Springt zum nächsten Schritt des Wasserfalls.

Parameter:

result - Optional, Ergebnis, das an den nächsten Schritt des aktuellen Wasserfalldialogfelds übergeben werden soll.

Gibt zurück:

Eine CompletableFuture, die die auszuführende Arbeitswarteschlange darstellt. Im nächsten Schritt des Wasserfalls enthält die result Eigenschaft des Wasserfallschrittkontexts den Wert der .

Gilt für: