المرجع: قناة
قناة إشعارات تُستخدم لمراقبة تغييرات الموارد.
تمثيل 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 |
تحدد هذا أنّها قناة إشعارات يتم استخدامها لمراقبة التغييرات في مورد، وهو |
الطُرق |
|
---|---|
|
تتوقف عن مشاهدة الموارد من خلال هذه القناة. |