DurableEntityContext interface

الحزمة:

durable-functions

يوفر وظائف للتعليمات البرمجية للتطبيق الذي ينفذ عملية كيان.

الخصائص

entityId	يحصل على معرف الكيان المنفذ حاليا.
entityKey	يحصل على مفتاح الكيان المنفذ حاليا.
entityName	يحصل على اسم الكيان المنفذ حاليا.
isNewlyConstructed	ما إذا كان هذا الكيان قد تم إنشاؤه حديثا، أي لم يكن موجودا قبل استدعاء هذه العملية.
operationName	يحصل على اسم العملية التي تم استدعاؤها. يتضمن استدعاء العملية على كيان اسم عملية، والذي ينص على العملية التي يجب تنفيذها، واختياريا إدخال عملية.

الأساليب

destructOnExit()	حذف هذا الكيان بعد اكتمال هذه العملية.
getInput<TInput>()	الحصول على الإدخال لهذه العملية. يتضمن استدعاء العملية على كيان اسم عملية، والذي ينص على العملية التي يجب تنفيذها، واختياريا إدخال عملية.
getState(() => TState)	الحصول على الحالة الحالية لهذا الكيان، للقراءة و/أو الكتابة.
return<TResult>(TResult)	إرجاع النتيجة المحددة إلى المتصل بهذه العملية.
setState(TState)	تعيين الحالة الحالية لهذا الكيان.
signalEntity(EntityId, string, unknown)	يشير إلى كيان لتنفيذ عملية، دون انتظار استجابة. يتم تجاهل أي نتيجة أو استثناء (النار والنسيان).

تفاصيل الخاصية

entityId

يحصل على معرف الكيان المنفذ حاليا.

entityId: EntityId

قيمة الخاصية

EntityId

entityKey

يحصل على مفتاح الكيان المنفذ حاليا.

entityKey: string

قيمة الخاصية

string

entityName

يحصل على اسم الكيان المنفذ حاليا.

entityName: string

قيمة الخاصية

string

isNewlyConstructed

ما إذا كان هذا الكيان قد تم إنشاؤه حديثا، أي لم يكن موجودا قبل استدعاء هذه العملية.

isNewlyConstructed: boolean

قيمة الخاصية

boolean

operationName

يحصل على اسم العملية التي تم استدعاؤها.

يتضمن استدعاء العملية على كيان اسم عملية، والذي ينص على العملية التي يجب تنفيذها، واختياريا إدخال عملية.

operationName: undefined | string

قيمة الخاصية

undefined | string

تفاصيل الأسلوب

destructOnExit()

حذف هذا الكيان بعد اكتمال هذه العملية.

function destructOnExit()

getInput<TInput>()

الحصول على الإدخال لهذه العملية.

يتضمن استدعاء العملية على كيان اسم عملية، والذي ينص على العملية التي يجب تنفيذها، واختياريا إدخال عملية.

function getInput<TInput>(): undefined | TInput

المرتجعات

undefined | TInput

إدخال العملية، أو غير معرف إن لم يكن.

getState(() => TState)

الحصول على الحالة الحالية لهذا الكيان، للقراءة و/أو الكتابة.

function getState(initializer?: () => TState): undefined | TState

المعلمات

initializer

() => TState

يوفر قيمة أولية لاستخدامها للحالة، بدلا من القيمة الافتراضية ل TState.

المرتجعات

undefined | TState

الحالة الحالية لهذا الكيان، أو غير معرفة إذا لم يتم تعيين أي منها حتى الآن.

return<TResult>(TResult)

إرجاع النتيجة المحددة إلى المتصل بهذه العملية.

function return<TResult>(result: TResult)

المعلمات

result

TResult

النتيجة التي يجب إرجاعها.

setState(TState)

تعيين الحالة الحالية لهذا الكيان.

function setState(state: TState)

المعلمات

state

TState

حالة الكيان.

signalEntity(EntityId, string, unknown)

يشير إلى كيان لتنفيذ عملية، دون انتظار استجابة. يتم تجاهل أي نتيجة أو استثناء (النار والنسيان).

function signalEntity(entity: EntityId, operationName: string, operationInput?: unknown)

المعلمات

entity

EntityId

الكيان الهدف.

operationName

string

اسم العملية.

operationInput

unknown

إدخال العملية.