BotState الفصل

‏‏المرجع

تعريف كائن إدارة الحالة وأتمتة قراءة وكتابة خصائص الحالة المقترنة بطبقة تخزين.

تهيئة مثيل جديد لفئة BotState.

الدالمنشئ

BotState(storage: Storage, context_service_key: str)

المعلمات

الاسم	الوصف
storage مطلوب	<xref:bptbuilder.core.Storage> طبقة التخزين التي سيستخدمها كائن إدارة الحالة هذا لتخزين الحالة واستردادها
context_service_key مطلوب	str مفتاح ذاكرة التخزين المؤقت للحالة لهذا BotState

الملاحظات

ينشئ هذا المنشئ كائن إدارة الحالة والنطاق المقترن. يستخدم الكائن تخزين :p aram: للحفاظ على قيم خصائص الحالة :p aram context_service_key: لتخزين الحالة مؤقتا ضمن السياق لكل دور.

الأساليب

clear_state	مسح أي حالة مخزنة حاليا في نطاق الحالة هذا.
create_property	إنشاء تعريف خاصية وتسجيله مع هذا BotState.
delete	حذف أي حالة مخزنة حاليا في نطاق الحالة هذا.
delete_property_value	حذف خاصية من ذاكرة التخزين المؤقت للحالة في سياق الدور.
get
get_cached_state	يحصل على مثيل حالة الروبوت المخزن مؤقتا الذي يلف البيانات المخزنة مؤقتا الأولية لهذا "BotState" من سياق الدوران.
get_property_value	يحصل على قيمة الخاصية المحددة في سياق الدور.
get_storage_key
load	قراءة كائن الحالة الحالي وتخزينه مؤقتا في كائن السياق لهذا الدور.
save_changes	حفظ الحالة المخزنة مؤقتا في السياق الحالي لهذا الدور. إذا تغيرت الحالة، فإنه يحفظ الحالة المخزنة مؤقتا في السياق الحالي لهذا الدور.
set_property_value	تعيين خاصية إلى القيمة المحددة في سياق الدور.

clear_state

مسح أي حالة مخزنة حاليا في نطاق الحالة هذا.

async clear_state(turn_context: TurnContext)

المعلمات

الاسم	الوصف
turn_context مطلوب	TurnContext كائن السياق لهذا الدور

المرتجعات

النوع	الوصف
	اي

الملاحظات

يجب استدعاء هذه الدالة من أجل استمرار حالة المسح إلى المخزن الأساسي.

create_property

إنشاء تعريف خاصية وتسجيله مع هذا BotState.

create_property(name: str) -> StatePropertyAccessor

المعلمات

الاسم	الوصف
name مطلوب	str اسم الخاصية

المرتجعات

النوع	الوصف
StatePropertyAccessor	إذا نجحت، تم إنشاء ملحق خاصية الحالة

delete

حذف أي حالة مخزنة حاليا في نطاق الحالة هذا.

async delete(turn_context: TurnContext) -> None

المعلمات

الاسم	الوصف
turn_context مطلوب	TurnContext كائن السياق لهذا الدور

المرتجعات

النوع	الوصف
	اي

delete_property_value

حذف خاصية من ذاكرة التخزين المؤقت للحالة في سياق الدور.

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

المعلمات

الاسم	الوصف
turn_context مطلوب	<xref:<xref::TurnContext`>> كائن السياق لهذا الدور
property_name مطلوب	str اسم الخاصية المراد حذفها

المرتجعات

النوع	الوصف
	اي

get

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

المعلمات

الاسم	الوصف
turn_context مطلوب

get_cached_state

يحصل على مثيل حالة الروبوت المخزن مؤقتا الذي يلف البيانات المخزنة مؤقتا الأولية لهذا "BotState" من سياق الدوران.

get_cached_state(turn_context: TurnContext)

المعلمات

الاسم	الوصف
turn_context مطلوب	TurnContext كائن السياق لهذا الدور.

المرتجعات

النوع	الوصف
	مثيل حالة الروبوت المخزن مؤقتا.

get_property_value

يحصل على قيمة الخاصية المحددة في سياق الدور.

async get_property_value(turn_context: TurnContext, property_name: str)

المعلمات

الاسم	الوصف
turn_context مطلوب	TurnContext كائن السياق لهذا الدور
property_name مطلوب	str اسم الخاصية

المرتجعات

النوع	الوصف
	قيمة الخاصية

get_storage_key

abstract get_storage_key(turn_context: TurnContext) -> str

المعلمات

الاسم	الوصف
turn_context مطلوب

load

قراءة كائن الحالة الحالي وتخزينه مؤقتا في كائن السياق لهذا الدور.

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

المعلمات

الاسم	الوصف
turn_context مطلوب	TurnContext كائن السياق لهذا الدور
force	bool اختياري، صحيح لتجاوز ذاكرة التخزين المؤقت القيمة الافتراضية: False

save_changes

حفظ الحالة المخزنة مؤقتا في السياق الحالي لهذا الدور. إذا تغيرت الحالة، فإنه يحفظ الحالة المخزنة مؤقتا في السياق الحالي لهذا الدور.

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

المعلمات

الاسم	الوصف
turn_context مطلوب	TurnContext كائن السياق لهذا الدور
force	bool اختياري، صحيح لحفظ الحالة في التخزين سواء كانت هناك تغييرات أم لا القيمة الافتراضية: False

set_property_value

تعيين خاصية إلى القيمة المحددة في سياق الدور.

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

المعلمات

الاسم	الوصف
turn_context مطلوب	TurnContext كائن السياق لهذا الدور
property_name مطلوب	str اسم الخاصية
value مطلوب	<xref:Object> القيمة المراد تعيينها إلى الخاصية

المرتجعات

النوع	الوصف
	اي

الملاحظات

هل كانت هذه الصفحة مفيدة؟