BotState Klasa

Odwołanie

Definiuje obiekt zarządzania stanem i automatyzuje odczytywanie i zapisywanie skojarzonych właściwości stanu w warstwie magazynu.

Inicjuje nowe wystąpienie klasy BotState.

Konstruktor

BotState(storage: Storage, context_service_key: str)

Parametry

Nazwa	Opis
storage Wymagane	<xref:bptbuilder.core.Storage> Warstwa magazynu, która będzie używać tego obiektu zarządzania stanem do przechowywania i pobierania stanu
context_service_key Wymagane	str Klucz pamięci podręcznej stanu dla tej BotState

Uwagi

Ten konstruktor tworzy obiekt zarządzania stanem i skojarzony zakres. Obiekt używa magazynu :p aram: do utrwalania wartości właściwości stanu i :p ram context_service_key: do buforowania stanu w kontekście dla każdego kolei.

Metody

clear_state	Czyści wszystkie stany, które są obecnie przechowywane w tym zakresie stanu.
create_property	Tworzy definicję właściwości i rejestruje ją w tym BotState.
delete	Usuwa wszystkie stany, które są obecnie przechowywane w tym zakresie stanu.
delete_property_value	Usuwa właściwość z pamięci podręcznej stanu w kontekście kolei.
get
get_cached_state	Pobiera buforowane wystąpienie stanu bota, które opakowuje nieprzetworzone dane buforowane dla tego "BotState" z kontekstu kolei.
get_property_value	Pobiera wartość określonej właściwości w kontekście kolei.
get_storage_key
load	Odczytuje bieżący obiekt stanu i buforuje go w obiekcie kontekstu dla tego kolei.
save_changes	Zapisuje stan buforowany w bieżącym kontekście dla tego kolei. Jeśli stan uległ zmianie, zapisuje stan buforowany w bieżącym kontekście dla tego kolei.
set_property_value	Ustawia właściwość na określoną wartość w kontekście kolei.

clear_state

Czyści wszystkie stany, które są obecnie przechowywane w tym zakresie stanu.

async clear_state(turn_context: TurnContext)

Parametry

Nazwa	Opis
turn_context Wymagane	TurnContext Obiekt kontekstu dla tego kolei

Zwraca

Typ	Opis
	Żaden

Uwagi

Ta funkcja musi być wywoływana, aby stan wyczyszczonego był utrwalany w magazynie bazowym.

create_property

Tworzy definicję właściwości i rejestruje ją w tym BotState.

create_property(name: str) -> StatePropertyAccessor

Parametry

Nazwa	Opis
name Wymagane	str Nazwa właściwości

Zwraca

Typ	Opis
StatePropertyAccessor	W przypadku pomyślnego utworzenia metody dostępu właściwości stanu

delete

Usuwa wszystkie stany, które są obecnie przechowywane w tym zakresie stanu.

async delete(turn_context: TurnContext) -> None

Parametry

Nazwa	Opis
turn_context Wymagane	TurnContext Obiekt kontekstu dla tego kolei

Zwraca

Typ	Opis
	Żaden

delete_property_value

Usuwa właściwość z pamięci podręcznej stanu w kontekście kolei.

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

Parametry

Nazwa	Opis
turn_context Wymagane	<xref:<xref::TurnContext`>> Obiekt kontekstu dla tego kolei
property_name Wymagane	str Nazwa właściwości do usunięcia

Zwraca

Typ	Opis
	Żaden

get

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

Parametry

Nazwa	Opis
turn_context Wymagane

get_cached_state

Pobiera buforowane wystąpienie stanu bota, które opakowuje nieprzetworzone dane buforowane dla tego "BotState" z kontekstu kolei.

get_cached_state(turn_context: TurnContext)

Parametry

Nazwa	Opis
turn_context Wymagane	TurnContext Obiekt kontekstu dla tego kolei.

Zwraca

Typ	Opis
	Buforowane wystąpienie stanu bota.

get_property_value

Pobiera wartość określonej właściwości w kontekście kolei.

async get_property_value(turn_context: TurnContext, property_name: str)

Parametry

Nazwa	Opis
turn_context Wymagane	TurnContext Obiekt kontekstu dla tego kolei
property_name Wymagane	str Nazwa właściwości

Zwraca

Typ	Opis
	Wartość właściwości

get_storage_key

abstract get_storage_key(turn_context: TurnContext) -> str

Parametry

Nazwa	Opis
turn_context Wymagane

load

Odczytuje bieżący obiekt stanu i buforuje go w obiekcie kontekstu dla tego kolei.

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

Parametry

Nazwa	Opis
turn_context Wymagane	TurnContext Obiekt kontekstu dla tego kolei
force	bool Opcjonalne, prawda, aby pominąć pamięć podręczną Domyślna wartość: False

save_changes

Zapisuje stan buforowany w bieżącym kontekście dla tego kolei. Jeśli stan uległ zmianie, zapisuje stan buforowany w bieżącym kontekście dla tego kolei.

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

Parametry

Nazwa	Opis
turn_context Wymagane	TurnContext Obiekt kontekstu dla tego kolei
force	bool Opcjonalnie, prawda, aby zapisać stan w magazynie bez względu na to, czy istnieją zmiany Domyślna wartość: False

set_property_value

Ustawia właściwość na określoną wartość w kontekście kolei.

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

Parametry

Nazwa	Opis
turn_context Wymagane	TurnContext Obiekt kontekstu dla tego kolei
property_name Wymagane	str Nazwa właściwości
value Wymagane	<xref:Object> Wartość, która ma zostać przypisana do właściwości

Zwraca

Typ	Opis
	Żaden

Opinia

Czy ta strona była pomocna?