BotState Sınıf

Başvuru

Durum yönetimi nesnesini tanımlar ve ilişkili durum özelliklerinin bir depolama katmanına okunmasını ve yazmasını otomatikleştirir.

BotState sınıfının yeni bir örneğini başlatır.

Oluşturucu

BotState(storage: Storage, context_service_key: str)

Parametreler

Name	Description
storage Gerekli	<xref:bptbuilder.core.Storage> Bu durum yönetim nesnesinin durumu depolamak ve almak için kullanacağı depolama katmanı
context_service_key Gerekli	str Bu BotState için durum önbelleği anahtarı

Açıklamalar

Bu oluşturucu bir durum yönetimi nesnesi ve ilişkili kapsam oluşturur. nesnesi, durum özellik değerlerini kalıcı hale getirmek için :p aram depolamasını kullanır ve :p aram context_service_key: her dönüş için bağlam içinde durumu önbelleğe almak için.

Yöntemler

clear_state	Şu anda bu durum kapsamında depolanan tüm durumları temizler.
create_property	Bir özellik tanımı oluşturur ve bu BotStateile kaydeder.
delete	Şu anda bu durum kapsamında depolanan tüm durumları siler.
delete_property_value	Dönüş bağlamında durum önbelleğinden bir özelliği siler.
get
get_cached_state	Bu "BotState" için ham önbelleğe alınmış verileri dönüş bağlamından sarmalayan önbelleğe alınmış bot durumu örneğini alır.
get_property_value	Turn bağlamında belirtilen özelliğin değerini alır.
get_storage_key
load	Geçerli durum nesnesini okur ve bu dönüş için bağlam nesnesinde önbelleğe alır.
save_changes	Bu dönüş için geçerli bağlamda önbelleğe alınmış durumu kaydeder. Durum değiştiyse, bu dönüş için geçerli bağlamda önbelleğe alınan durumu kaydeder.
set_property_value	Dönüş bağlamında belirtilen değere bir özellik ayarlar.

clear_state

Şu anda bu durum kapsamında depolanan tüm durumları temizler.

async clear_state(turn_context: TurnContext)

Parametreler

Name	Description
turn_context Gerekli	TurnContext Bu dönüş için bağlam nesnesi

Döndürülenler

Tür	Description
	Hiç kimse

Açıklamalar

Temizlenen durumun temel alınan depoda kalıcı olması için bu işlev çağrılmalıdır.

create_property

Bir özellik tanımı oluşturur ve bu BotStateile kaydeder.

create_property(name: str) -> StatePropertyAccessor

Parametreler

Name	Description
name Gerekli	str Özelliğin adı

Döndürülenler

Tür	Description
StatePropertyAccessor	Başarılı olursa, durum özelliği erişimcisi oluşturuldu

delete

Şu anda bu durum kapsamında depolanan tüm durumları siler.

async delete(turn_context: TurnContext) -> None

Parametreler

Name	Description
turn_context Gerekli	TurnContext Bu dönüş için bağlam nesnesi

Döndürülenler

Tür	Description
	Hiç kimse

delete_property_value

Dönüş bağlamında durum önbelleğinden bir özelliği siler.

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

Parametreler

Name	Description
turn_context Gerekli	<xref:<xref::TurnContext`>> Bu dönüş için bağlam nesnesi
property_name Gerekli	str Silinecek özelliğin adı

Döndürülenler

Tür	Description
	Hiç kimse

get

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

Parametreler

Name	Description
turn_context Gerekli

get_cached_state

Bu "BotState" için ham önbelleğe alınmış verileri dönüş bağlamından sarmalayan önbelleğe alınmış bot durumu örneğini alır.

get_cached_state(turn_context: TurnContext)

Parametreler

Name	Description
turn_context Gerekli	TurnContext Bu dönüş için bağlam nesnesi.

Döndürülenler

Tür	Description
	Önbelleğe alınmış bot durumu örneği.

get_property_value

Turn bağlamında belirtilen özelliğin değerini alır.

async get_property_value(turn_context: TurnContext, property_name: str)

Parametreler

Name	Description
turn_context Gerekli	TurnContext Bu dönüş için bağlam nesnesi
property_name Gerekli	str Özellik adı

Döndürülenler

Tür	Description
	Özelliğin değeri

get_storage_key

abstract get_storage_key(turn_context: TurnContext) -> str

Parametreler

Name	Description
turn_context Gerekli

load

Geçerli durum nesnesini okur ve bu dönüş için bağlam nesnesinde önbelleğe alır.

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

Parametreler

Name	Description
turn_context Gerekli	TurnContext Bu dönüş için bağlam nesnesi
force	bool İsteğe bağlı, önbelleği atlamak için true Default value: False

save_changes

Bu dönüş için geçerli bağlamda önbelleğe alınmış durumu kaydeder. Durum değiştiyse, bu dönüş için geçerli bağlamda önbelleğe alınan durumu kaydeder.

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

Parametreler

Name	Description
turn_context Gerekli	TurnContext Bu dönüş için bağlam nesnesi
force	bool İsteğe bağlı, değişiklik olup olmadığına bakılmaksızın durumu depolamaya kaydetmek için true Default value: False

set_property_value

Dönüş bağlamında belirtilen değere bir özellik ayarlar.

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

Parametreler

Name	Description
turn_context Gerekli	TurnContext Bu dönüş için bağlam nesnesi
property_name Gerekli	str Özellik adı
value Gerekli	<xref:Object> Özelliğine atanacak değer

Döndürülenler

Tür	Description
	Hiç kimse

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?