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

बूलियन वैल्यू, जिससे यह पता चलता है कि पेलोड चाहिए या नहीं. ज़रूरी नहीं.

id

string

यह चैनल की पहचान करने वाला यूयूआईडी या इसी तरह की कोई यूनीक स्ट्रिंग है.

resourceId

string

यह एक ओपेक आईडी है. इससे उस संसाधन की पहचान होती है जिसे इस चैनल पर देखा जा रहा है. एपीआई के अलग-अलग वर्शन पर स्टेबल.

resourceUri

string

देखे गए संसाधन के लिए, वर्शन के हिसाब से आइडेंटिफ़ायर.

token

string

यह एक ऐसी स्ट्रिंग होती है जिसे टारगेट पते पर भेजा जाता है. इस चैनल पर भेजी जाने वाली हर सूचना के साथ इसे भेजा जाता है. ज़रूरी नहीं.

expiration

string (int64 format)

सूचना चैनल की समयसीमा खत्म होने की तारीख और समय. इसे यूनिक्स टाइमस्टैंप के तौर पर, मिलीसेकंड में दिखाया जाता है. ज़रूरी नहीं.

type

string

इस चैनल के लिए इस्तेमाल किए गए डिलीवरी मैकेनिज़्म का टाइप. मान्य वैल्यू "web_hook" या "webhook" हैं.

address

string

वह पता जहां इस चैनल के लिए सूचनाएं भेजी जाती हैं.

kind

string

इससे यह पता चलता है कि यह सूचना देने वाला चैनल है. इसका इस्तेमाल किसी संसाधन में होने वाले बदलावों पर नज़र रखने के लिए किया जाता है. यह संसाधन api#channel है.

तरीके

stop

इस चैनल के ज़रिए संसाधनों को देखना बंद कर देता है.