REST Resource: channels

المرجع: قناة

قناة إشعارات تُستخدَم لرصد التغييرات في الموارد

تمثيل JSON 
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
الحقول
payload

boolean

قيمة منطقية للإشارة إلى ما إذا كانت الحمولة مطلوبة. اختياريّ.
id

string

معرّف فريد عالمي (UUID) أو سلسلة فريدة مشابهة تحدد هذه القناة.
resourceId

string

معرّف مبهم يحدد المورد الذي تتم مشاهدته على هذه القناة. استقرار في إصدارات واجهة برمجة التطبيقات المختلفة
resourceUri

string

معرّف خاص بالإصدار للمورد الذي تمت مشاهدته.
token

string

سلسلة عشوائية يتم إرسالها إلى العنوان المستهدف مع كل إشعار يتم إرساله عبر هذه القناة. اختياريّ.
expiration

string (int64 format)

تاريخ ووقت انتهاء صلاحية قناة الإشعار، معبرًا عنه بطابع زمني لنظام التشغيل Unix، بالمللي ثانية اختياريّ.
type

string

نوع آلية إرسال المحتوى المستخدَمة في هذه القناة. القيم الصالحة هي "web_hook" أو "الرد التلقائي على الويب".
address

string

العنوان الذي يتم إرسال الإشعارات إليه لهذه القناة
params

map (key: string, value: string)

معلَمات إضافية تتحكّم في سلوك قناة التسليم. اختياريّ.

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }
kind

string

يحدّد هذا الحقل على أنّه قناة إشعارات تُستخدَم لرصد التغييرات في أحد الموارد، وهو "api#channel".

الطُرق

stop

 التوقّف عن مشاهدة المراجع من خلال هذه القناة