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" أو "webhook".
address

string

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

map (key: string, value: string)

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

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

string

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

الطُرق

stop

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