BotState Klasse

  • Referenz
Paket:
com.microsoft.bot.builder
Maven-Artefakt:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.BotState

Implementiert

PropertyManager-

public abstract class BotState
implements PropertyManager

Definiert ein Zustandsverwaltungsobjekt und automatisiert das Lesen und Schreiben von zugeordneten Zustandseigenschaften in eine Speicherebene.

Jedes Zustandsverwaltungsobjekt definiert einen Bereich für eine Speicherebene. Statuseigenschaften werden in einem Zustandsverwaltungsbereich erstellt, und das Bot Framework definiert die folgenden Bereiche: ConversationState, UserStateund PrivateConversationState. Sie können zusätzliche Bereiche für Ihren Bot definieren.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
BotState(Storage withStorage, String withContextServiceKey)

Initialisiert eine neue Instanz der Bot-State-Klasse.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
StatePropertyAccessor<T> <T>createProperty(String name)

Erstellt eine benannte Zustandseigenschaft im Bereich eines Bot-State und gibt einen Accessor für die Eigenschaft zurück.
protected java.util.concurrent.CompletableFuture<T> <T>getPropertyValue(TurnContext turnContext, String propertyName)

Ruft den Wert einer Eigenschaft aus dem Statuscache für diesen BotState ab.
java.util.concurrent.CompletableFuture<java.lang.Void> clearState(TurnContext turnContext)

Löscht den Statuscache für diesen BotZustand.
java.util.concurrent.CompletableFuture<java.lang.Void> delete(TurnContext turnContext)

Löschen Sie alle status, die derzeit in diesem Statusbereich gespeichert sind.
protected java.util.concurrent.CompletableFuture<java.lang.Void> deletePropertyValue(TurnContext turnContext, String propertyName)

Löscht eine Eigenschaft aus dem Statuscache für diesen BotState.
com.fasterxml.jackson.databind.JsonNode get(TurnContext turnContext)

Ruft eine Kopie der rohen zwischengespeicherten Daten für diesen BotStatus aus dem Turnkontext ab.
CachedBotState getCachedState(TurnContext turnContext)

Ruft die zwischengespeicherte Bot-Zustandsinstanz ab, die die rohen zwischengespeicherten Daten für diesen BotStatus aus dem Turnkontext umschließt.
abstract java.lang.String getStorageKey(TurnContext turnContext)

Wenn sie in einer abgeleiteten Klasse überschrieben werden, ruft den Schlüssel ab, der beim Lesen und Schreiben des Zustands in und vom Speicher verwendet werden soll.
java.util.concurrent.CompletableFuture<java.lang.Void> load(TurnContext turnContext)

Füllt den Statuscache für diesen BotZustand von der Speicherebene aus.
java.util.concurrent.CompletableFuture<java.lang.Void> load(TurnContext turnContext, boolean force)

Liest das aktuelle Zustandsobjekt und speichert es im Kontextobjekt für diese Aufgabe zwischen.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(TurnContext turnContext)

Schreibt den Statuscache für diesen BotStatus in die Speicherebene.
java.util.concurrent.CompletableFuture<java.lang.Void> saveChanges(TurnContext turnContext, boolean force)

Schreibt den Statuscache für diesen BotStatus in die Speicherebene.
protected java.util.concurrent.CompletableFuture<java.lang.Void> setPropertyValue(TurnContext turnContext, String propertyName, Object value)

Legt den Wert einer Eigenschaft im Statuscache für diesen BotState fest.

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

BotState

public BotState(Storage withStorage, String withContextServiceKey)

Initialisiert eine neue Instanz der BotState-Klasse.

Parameter:

withStorage - Der zu verwendende Speicheranbieter.
withContextServiceKey - Der Schlüssel für den Statuscache für diesen BotState.

Löst aus:

java.lang.IllegalArgumentException - Null-Speicher- oder leere Dienstschlüsselargumente.

Details zur Methode

<T>createProperty

public StatePropertyAccessor createProperty(String name)

Erstellt eine benannte Zustandseigenschaft innerhalb des Bereichs eines BotState und gibt einen Accessor für die Eigenschaft zurück.

Parameter:

name - Name der Eigenschaft.

Gibt zurück:

Eine StatePropertyAccessor<T> für die Eigenschaft.

Löst aus:

java.lang.IllegalArgumentException - Leerer Name

<T>getPropertyValue

protected CompletableFuture getPropertyValue(TurnContext turnContext, String propertyName)

Ruft den Wert einer Eigenschaft aus dem Statuscache für diesen BotState ab.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.
propertyName - Der Name der abzurufenden Eigenschaft.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Wenn der Vorgang erfolgreich ist, enthält das Ergebnis den Eigenschaftswert.

clearState

public CompletableFuture clearState(TurnContext turnContext)

Löscht den Statuscache für diesen BotState.

Mit dieser Methode wird der Statuscache im Turnkontext gelöscht. Rufen Sie saveChanges(TurnContext turnContext, boolean force) auf, um diese Änderung auf der Speicherebene beizubehalten.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

delete

public CompletableFuture delete(TurnContext turnContext)

Löschen Sie alle status, die derzeit in diesem Statusbereich gespeichert sind.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

deletePropertyValue

protected CompletableFuture deletePropertyValue(TurnContext turnContext, String propertyName)

Löscht eine Eigenschaft aus dem Statuscache für diesen BotState.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.
propertyName - Der Name der zu löschenden Eigenschaft.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

get

public JsonNode get(TurnContext turnContext)

Ruft eine Kopie der rohen zwischengespeicherten Daten für diesen BotState aus dem Turnkontext ab.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.

Gibt zurück:

Eine JSON-Darstellung des zwischengespeicherten Zustands.

getCachedState

public BotState.CachedBotState getCachedState(TurnContext turnContext)

Ruft die zwischengespeicherte Bot-Zustandsinstanz ab, die die rohen zwischengespeicherten Daten für diesen BotState aus dem Turnkontext umschließt.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.

Gibt zurück:

Die zwischengespeicherte Bot-Zustandsinstanz.

getStorageKey

public abstract String getStorageKey(TurnContext turnContext)

Wenn sie in einer abgeleiteten Klasse überschrieben werden, ruft den Schlüssel ab, der beim Lesen und Schreiben des Zustands in und vom Speicher verwendet werden soll.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.

Gibt zurück:

Der Speicherschlüssel.

Löst aus:

java.lang.IllegalArgumentException - TurnContext enthält nicht alle erforderlichen Daten.

load

public CompletableFuture load(TurnContext turnContext)

Füllt den Statuscache für diesen BotState aus der Speicherebene auf.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

load

public CompletableFuture load(TurnContext turnContext, boolean force)

Liest das aktuelle Zustandsobjekt und speichert es im Kontextobjekt für diese Aufgabe zwischen.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.
force - true, um alle vorhandenen Statuscaches zu überschreiben; oder "false", um den Zustand nur aus dem Speicher zu laden, wenn der Cache noch nicht vorhanden ist.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

saveChanges

public CompletableFuture saveChanges(TurnContext turnContext)

Schreibt den Statuscache für diesen BotState in die Speicherebene.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

saveChanges

public CompletableFuture saveChanges(TurnContext turnContext, boolean force)

Schreibt den Statuscache für diesen BotState in die Speicherebene.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.
force - true, um den Zustandscache im Speicher zu speichern; oder "false", um den Zustand nur im Speicher zu speichern, wenn sich eine Eigenschaft im Cache geändert hat.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

setPropertyValue

protected CompletableFuture setPropertyValue(TurnContext turnContext, String propertyName, Object value)

Legt den Wert einer Eigenschaft im Statuscache für diesen BotState fest.

Parameter:

turnContext - Das Kontextobjekt für diese Drehung.
propertyName - Der Name der festzulegenden Eigenschaft.
value - Der wert, der für die Eigenschaft festgelegt werden soll.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

Gilt für: