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

نوع آلية التسليم المستخدَمة لهذه القناة.
address

string

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

map (key: string, value: string)

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

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

string

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

الطُرق

stop

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