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

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

resourceId

string

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

resourceUri

string

देखे गए संसाधन के लिए किसी वर्शन की खास पहचान करने वाला.

token

string

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

expiration

string (int64 format)

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

type

string

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

address

string

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

params

map (key: string, value: string)

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

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

kind

string

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

तरीके

stop

इस चैनल पर संसाधनों को देखना बंद करता है.