انتقل إلى المحتوى الرئيسي

subscribeToForm

اشترك في حدث نموذج بواسطة العلامة. 🔐 تتطلب هذه الطريقة التفويض.

الوصف

تقوم هذه الطريقة بالاشتراك للمستخدم الحالي في حدث نموذج يتم تحديده بواسطة علامته، لسجل بيانات نموذج محدد. تعيد Promise التي تحل إلى true إذا كانت الاشتراك ناجحًا، أو كائن IError إذا كان هناك مشكلة.

Events.subscribeToForm(

marker*, body*, body.formDataId*, body.status

);

مخطط المعلمات

المخطط

marker(required): string
علامة الحدث
مثال: "form_marker"

body(required): ISubscribeFormEvent
نص الاشتراك. مثال: { formDataId: 123 }

body.formDataId(required): number
معرف بيانات النموذج.
مثال: 123

body.status: string
حالة الاشتراك الاختيارية.

أمثلة

مثال بسيط

const response = await Events.subscribeToForm('form_marker', { formDataId: 123 });

استجابة المثال

true

مخطط الاستجابة

المخطط: boolean

boolean: boolean
ترجع true إذا كانت الاشتراك ناجحًا.
مثال: true