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

unsubscribeFromForm

إلغاء الاشتراك من إشعارات النموذج بواسطة العلامة. 🔐 تتطلب هذه الطريقة التفويض.

الوصف

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

Events.unsubscribeFromForm(

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.unsubscribeFromForm('form_marker', { formDataId: 123 });

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

true

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

المخطط: boolean

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