تمت ترجمة هذه الوثائق تلقائيًا بواسطة الذكاء الاصطناعي.
يُعرّف EventDefinition منطق معالجة الأحداث ضمن سير العمل، ويُستخدم للاستجابة لمُشغّلات أحداث مُحدّدة. تُعد الأحداث آلية مهمة في محرك سير العمل لتشغيل تنفيذ سير العمل.
يُعد EventDefinition في الواقع اسمًا مستعارًا لـ ActionDefinition، وبالتالي فهو يمتلك نفس الخصائص والأساليب.
النوع: string
مطلوب: نعم
الوصف: المعرّف الفريد للحدث.
يُستخدم للإشارة إلى الحدث في سير العمل عبر الخاصية on.
مثال:
النوع: string
مطلوب: لا
الوصف: عنوان العرض للحدث.
يُستخدم للعرض في واجهة المستخدم ولأغراض التصحيح.
مثال:
النوع: (ctx: TCtx, params: any) => Promise<any> | any
مطلوب: نعم
الوصف: دالة المعالجة للحدث.
المنطق الأساسي للحدث، يستقبل السياق والمعاملات، ويعيد نتيجة المعالجة.
مثال:
النوع: Record<string, any> | ((ctx: TCtx) => Record<string, any> | Promise<Record<string, any>>)
مطلوب: لا
الوصف: المعاملات الافتراضية للحدث.
تُستخدم لملء المعاملات بقيم افتراضية عند تشغيل الحدث.
مثال:
النوع: Record<string, ISchema> | ((ctx: TCtx) => Record<string, ISchema> | Promise<Record<string, ISchema>>)
مطلوب: لا
الوصف: مخطط تهيئة واجهة المستخدم (UI) للحدث.
يُعرّف طريقة عرض الحدث وتهيئة النموذج في واجهة المستخدم.
مثال:
النوع: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
مطلوب: لا
الوصف: دالة ربط تُنفّذ قبل حفظ المعاملات.
تُنفّذ قبل حفظ معاملات الحدث، ويمكن استخدامها للتحقق من صحة المعاملات أو تحويلها.
مثال:
النوع: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
مطلوب: لا
الوصف: دالة ربط تُنفّذ بعد حفظ المعاملات.
تُنفّذ بعد حفظ معاملات الحدث، ويمكن استخدامها لتشغيل عمليات أخرى.
مثال:
النوع: StepUIMode | ((ctx: FlowRuntimeContext<TModel>) => StepUIMode | Promise<StepUIMode>)
مطلوب: لا
الوصف: وضع عرض واجهة المستخدم (UI) للحدث.
يتحكم في كيفية عرض الحدث في واجهة المستخدم.
الأوضاع المدعومة:
'dialog' - وضع الحوار (Dialog)'drawer' - وضع الدرج (Drawer)'embed' - وضع التضمين (Embed)مثال:
يحتوي محرك سير العمل على أنواع الأحداث الشائعة التالية المدمجة:
'click' - حدث النقر'submit' - حدث الإرسال'reset' - حدث إعادة الضبط'remove' - حدث الحذف'openView' - حدث فتح العرض'dropdownOpen' - حدث فتح القائمة المنسدلة'popupScroll' - حدث تمرير النافذة المنبثقة'search' - حدث البحث'customRequest' - حدث الطلب المخصص'collapseToggle' - حدث تبديل الطي