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

الاتصال

تقوم هذه الطريقة بإنشاء وإرجاع مثيل لكائن Socket.io مع اتصال. تتطلب هذه الطريقة تفويض المستخدم.

الوصف

عندما تتغير السمات (إذا كان المستخدم مشتركًا في الحدث المقابل وخيار Websocket مفعل في الحدث) يحتوي حقل "السمات" دائمًا على سمات الحدث (حقل "الأحداث")، وبناءً على نوع الحدث المحدد للفهرس أو النموذج، تحتوي الحقول ذات السمات "المنتج" على سمات المنتج، و"المستخدم" تحتوي على حقول من نموذج المستخدم، على التوالي. بالنسبة للمنتج، هناك حقل إضافي "العنوان" (اسم المنتج كسلسلة نصية)، ولنماذج التسجيل وتقديم الرموز، هناك حقول إضافية "الرمز" و"البريد الإلكتروني".

يتم تخزين قيمة السمة بتنسيق *key - marker*, *value - {type, identifier, value}*.

أمثلة

مثال بسيط

const socket = await WS.connect();

socket.on('my_event', callback);

مثال المنتج:

{
"product": {
"id": 10,
"info": {
"title": "كوكب وردي",
},
"status": {
"identifier": "متاح",
"info": {
"title": "أضف إلى السلة"
}
},
"attributes": {
"currency": {
"identifier": "currency",
"type": "string",
"value": "USD"
}
}
}
}

مثال المستخدم:

{
"user": {
"notificationData": {},
"attributes": {}
},
"order": {
"id": 1,
"attributes": {}
}
}

مثال الطلب:

{
"user": {
"notificationData": {},
"attributes": {}
},
"order": {
"id": 1,
"attributes": {}
}
}

مثال النموذج:

{
"email": "string",
"formData": {}
}

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

{
"message": "رسالة",
"attributes": {
"company": {
"identifier": "company",
"type": "string",
"value": "OneEntry"
}
}
}

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

المخطط: Socket

message string
نص الرسالة
مثال: رسالة

attributes: Record<string, any>
يحتوي على سمات الحدث
مثال:

{
"company": {
"identifier": "company",
"type": "string",
"value": "OneEntry"
}
}