REST Resource: channels

संसाधन: चैनल

संसाधनों में हुए बदलावों को देखने के लिए इस्तेमाल किया जाने वाला सूचना का चैनल.

जेएसओएन के काेड में दिखाना
{
  "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

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

resourceId

string

इस चैनल पर देखे जा रहे संसाधन की पहचान करने वाला ओपेक आईडी. एपीआई के अलग-अलग वर्शन में स्थिर है.

resourceUri

string

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

token

string

इस चैनल पर भेजी गई हर सूचना के साथ, टारगेट पते पर डिलीवर की गई एक आर्बिट्रेरी स्ट्रिंग. ज़रूरी नहीं.

expiration

string (int64 format)

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

type

string

इस चैनल के लिए, डिलीवरी के तरीके का टाइप. "web_हुक" या "वेबहुक" को सही वैल्यू माना जाता है.

address

string

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

params

map (key: string, value: string)

डिलीवरी चैनल के व्यवहार को कंट्रोल करने वाले अतिरिक्त पैरामीटर. ज़रूरी नहीं.

एक ऑब्जेक्ट जिसमें "key": value पेयर की सूची है. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

kind

string

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

तरीके

stop

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