BotState Klasse

Referenz

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

Initialisiert eine neue Instanz der BotState Klasse.

Konstruktor

BotState(storage: Storage, context_service_key: str)

Parameter

Name	Beschreibung
storage Erforderlich	<xref:bptbuilder.core.Storage> Die Speicherschicht, die dieses Statusverwaltungsobjekt zum Speichern und Abrufen des Zustands verwendet.
context_service_key Erforderlich	str Der Schlüssel für den Statuscache für diese BotState

Hinweise

Dieser Konstruktor erstellt ein Zustandsverwaltungsobjekt und einen zugeordneten Bereich. Das Objekt verwendet den :p aram-Speicher: um Zustandseigenschaftenwerte und die :p aram-context_service_key zu speichern: den Zustand innerhalb des Kontexts für jede Drehung zwischenzuspeichern.

Methoden

clear_state	Löscht alle aktuell in diesem Zustandsbereich gespeicherten Status.
create_property	Erstellt eine Eigenschaftsdefinition und registriert sie mit diesem BotState.
delete	Löscht jeden Zustand, der derzeit in diesem Statusbereich gespeichert ist.
delete_property_value	Löscht eine Eigenschaft aus dem Statuscache im Turnkontext.
get
get_cached_state	Ruft die zwischengespeicherte Bot-Zustandsinstanz ab, die die rohen zwischengespeicherten Daten für diesen "BotState" aus dem Turnkontext umschließt.
get_property_value	Ruft den Wert der angegebenen Eigenschaft im Turnkontext ab.
get_storage_key
load	Liest das aktuelle Zustandsobjekt und speichert es im Kontextobjekt für diese Aufgabe zwischen.
save_changes	Speichert den Zustand, der im aktuellen Kontext für diese Aufgabe zwischengespeichert wurde. Wenn sich der Zustand geändert hat, speichert er den Zustand, der im aktuellen Kontext für diesen Vorgang zwischengespeichert wurde.
set_property_value	Legt eine Eigenschaft auf den angegebenen Wert im Turnkontext fest.

clear_state

Löscht alle aktuell in diesem Zustandsbereich gespeicherten Status.

async clear_state(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diese Drehung

Gibt zurück

Typ	Beschreibung
	Nichts

Hinweise

Diese Funktion muss aufgerufen werden, damit der gelöschte Zustand im zugrunde liegenden Speicher beibehalten werden kann.

create_property

Erstellt eine Eigenschaftsdefinition und registriert sie mit diesem BotState.

create_property(name: str) -> StatePropertyAccessor

Parameter

Name	Beschreibung
name Erforderlich	str Der Name der Eigenschaft

Gibt zurück

Typ	Beschreibung
StatePropertyAccessor	Bei erfolgreicher Ausführung wurde der Statuseigenschaftsaccessor erstellt.

delete

Löscht jeden Zustand, der derzeit in diesem Statusbereich gespeichert ist.

async delete(turn_context: TurnContext) -> None

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diese Drehung

Gibt zurück

Typ	Beschreibung
	Nichts

delete_property_value

Löscht eine Eigenschaft aus dem Statuscache im Turnkontext.

async delete_property_value(turn_context: TurnContext, property_name: str) -> None

Parameter

Name	Beschreibung
turn_context Erforderlich	<xref:<xref::TurnContext`>> Das Kontextobjekt für diese Drehung
property_name Erforderlich	str Der Name der zu löschenden Eigenschaft

Gibt zurück

Typ	Beschreibung
	Nichts

get

get(turn_context: TurnContext) -> Dict[str, object]

Parameter

Name	Beschreibung
turn_context Erforderlich

get_cached_state

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

get_cached_state(turn_context: TurnContext)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diese Drehung.

Gibt zurück

Typ	Beschreibung
	Die zwischengespeicherte Bot-Zustandsinstanz.

get_property_value

Ruft den Wert der angegebenen Eigenschaft im Turnkontext ab.

async get_property_value(turn_context: TurnContext, property_name: str)

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diese Drehung
property_name Erforderlich	str Der Eigenschaftsname

Gibt zurück

Typ	Beschreibung
	Der Wert der Eigenschaft

get_storage_key

abstract get_storage_key(turn_context: TurnContext) -> str

Parameter

Name	Beschreibung
turn_context Erforderlich

load

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

async load(turn_context: TurnContext, force: bool = False) -> None

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diese Drehung
force	bool Optional, true, um den Cache zu umgehen Standardwert: False

save_changes

Speichert den Zustand, der im aktuellen Kontext für diese Aufgabe zwischengespeichert wurde. Wenn sich der Zustand geändert hat, speichert er den Zustand, der im aktuellen Kontext für diesen Vorgang zwischengespeichert wurde.

async save_changes(turn_context: TurnContext, force: bool = False) -> None

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diese Drehung
force	bool Optional, true, um den Zustand im Speicher zu speichern, unabhängig davon, ob Änderungen vorhanden sind. Standardwert: False

set_property_value

Legt eine Eigenschaft auf den angegebenen Wert im Turnkontext fest.

async set_property_value(turn_context: TurnContext, property_name: str, value: object) -> None

Parameter

Name	Beschreibung
turn_context Erforderlich	TurnContext Das Kontextobjekt für diese Drehung
property_name Erforderlich	str Der Eigenschaftsname
value Erforderlich	<xref:Object> Der Wert, der der Eigenschaft zugewiesen werden soll

Gibt zurück

Typ	Beschreibung
	Nichts

Feedback

War diese Seite hilfreich?