REST Resource: channels

منبع: کانال

یک کانال اطلاع رسانی که برای مشاهده تغییرات منابع استفاده می شود.

نمایندگی JSON 
{
  "params": {
    string: string,
    ...
  },
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "kind": string
}
فیلدها
params

map (key: string, value: string)

پارامترهای اضافی کنترل کننده رفتار کانال تحویل اختیاری.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

payload

boolean

یک مقدار Boolean برای نشان دادن اینکه آیا محموله مورد نظر است یا خیر. اختیاری.

id

string

یک UUID یا یک رشته منحصر به فرد مشابه که این کانال را شناسایی می کند.

resourceId

string

یک شناسه غیر شفاف که منبع در حال تماشا را در این کانال مشخص می کند. در نسخه های مختلف API پایدار است.

resourceUri

string

یک شناسه مخصوص نسخه برای منبع تماشا شده.

token

string

یک رشته دلخواه با هر اعلان از طریق این کانال به آدرس مورد نظر تحویل داده می شود. اختیاری.

expiration

string ( int64 format)

تاریخ و زمان انقضای کانال اعلان، به صورت مهر زمانی یونیکس، در میلی ثانیه بیان می شود. اختیاری.

type

string

نوع مکانیزم تحویل مورد استفاده برای این کانال. مقادیر معتبر "web_hook" یا "webhook" هستند.

address

string

آدرسی که اعلان‌های این کانال در آن ارسال می‌شود.

kind

string

این را به عنوان یک کانال اعلان شناسایی می کند که برای مشاهده تغییرات در یک منبع، که api#channel است، استفاده می شود.

روش ها

stop

 تماشای منابع از طریق این کانال را متوقف می کند.