المرجع: القناة
قناة إشعارات تُستخدَم للتتبّع المستمر لتغييرات الموارد
تمثيل JSON |
---|
{ "payload": boolean, "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": string, "type": string, "address": string, "params": { string: string, ... }, "kind": string } |
الحقول | |
---|---|
payload |
قيمة منطقية للإشارة إلى ما إذا كان يتم طلب الحمولة اختياريّ. |
id |
معرّف UUID أو سلسلة فريدة مشابهة تُحدِّد هذه القناة. |
resourceId |
معرّف غير شفاف يحدّد المورد الذي تتم مشاهدته على هذه القناة. أن تكون مستقرة على مستوى إصدارات واجهة برمجة التطبيقات المختلفة |
resourceUri |
معرّف خاص بالإصدار للمورد الذي تتم مشاهدته |
token |
سلسلة عشوائية يتم إرسالها إلى العنوان المستهدَف مع كل إشعار يتم إرساله عبر هذه القناة. اختياريّ. |
expiration |
تاريخ ووقت انتهاء صلاحية قناة الإشعارات، مُعبَّرًا عنه كطابع زمني لنظام التشغيل UNIX، بالمللي ثانية اختياريّ. |
type |
نوع آلية الإرسال المستخدَمة لهذه القناة. القيم الصالحة هي "web_hook" أو "webhook". |
address |
العنوان الذي يتم إرسال الإشعارات إليه لهذه القناة. |
params |
مَعلمات إضافية تتحكّم في سلوك قناة الإرسال اختياريّ. عنصر يحتوي على قائمة بأزواج |
kind |
يحدِّد هذا الحقل القناة على أنّها قناة إشعارات تُستخدَم للتتبّع عن كثب للتغييرات في المورد |
الطُرق |
|
---|---|
|
سيتوقّف عن مشاهدة المراجع من خلال هذه القناة. |