इस संसाधन के लिए उपलब्ध तरीकों की सूची देखने के लिए, इस पेज के आखिर में देखें.
संसाधन निरूपण
उपयोगकर्ता की टाइमलाइन में मौजूद हर आइटम को TimelineItem
JSON के स्ट्रक्चर के तौर पर दिखाया जाता है. इसके बारे में यहां बताया गया है.
{
"kind": "mirror#timelineItem",
"id":string ,
"sourceItemId":string ,
"canonicalUrl":string ,
"bundleId":string ,
"isBundleCover":boolean ,
"selfLink":string ,
"created":datetime ,
"updated":datetime ,
"displayTime":datetime ,
"isPinned":boolean ,
"pinScore":integer ,
"isDeleted":boolean ,
"etag":etag ,
"creator": contacts Resource,
"recipients": [
contacts Resource
],
"inReplyTo":string ,
"title":string ,
"text":string ,
"html":string ,
"speakableType":string ,
"speakableText":string ,
"attachments": [
timeline.attachments Resource
],
"location": locations Resource,
"menuItems": [
{
"id":string ,
"action":string ,
"values": [
{
"state":string ,
"displayName":string ,
"iconUrl":string
}
],
"removeWhenSelected":boolean ,
"payload":string
}
],
"notification": {
"level":string ,
"deliveryTime":datetime
}
}
प्रॉपर्टी का नाम | मान | ब्यौरा | नोट |
---|---|---|---|
attachments[] |
list |
इस आइटम से जुड़े मीडिया अटैचमेंट की सूची. सुविधा के लिए, अपने एचटीएमएल पेलोड में अटैचमेंट या सीआईडी स्कीम के साथ अटैचमेंट देखें. उदाहरण के लिए:
|
|
bundleId |
string |
इस आइटम का बंडल आईडी. कई आइटम को एक साथ ग्रुप करने के लिए, सेवाएं एक बंडल आईडी तय कर सकती हैं. वे डिवाइस पर एक टॉप-लेवल आइटम के नीचे दिखते हैं. | लिखा जा सकता है |
canonicalUrl |
string |
टाइमलाइन आइटम के ज़रिए दिखाए गए डेटा के कैननिकल/अच्छी क्वालिटी वाले वर्शन के बारे में बताने वाला कैननिकल यूआरएल. | लिखा जा सकता है |
created |
datetime |
जिस समय इस आइटम को बनाया गया था, उसे आरएफ़सी 3339 के हिसाब से फ़ॉर्मैट किया गया था. | |
creator |
nested object |
वह उपयोगकर्ता या ग्रुप जिसने यह आइटम बनाया है. | लिखा जा सकता है |
displayTime |
datetime |
वह समय जो इस आइटम को टाइमलाइन में देखे जाने पर दिखाया जाना चाहिए, जो आरएफ़सी 3339 के हिसाब से फ़ॉर्मैट किया गया है. इस उपयोगकर्ता की टाइमलाइन, दिखाए जाने के समय के हिसाब से क्रम में लगी होती है. इससे यह भी तय होता है कि टाइमलाइन में आइटम कहां दिखेगा. अगर सेवा सेट नहीं करती है, तो डिसप्ले टाइम डिफ़ॉल्ट रूप से updated समय पर सेट होता है. |
लिखा जा सकता है |
etag |
etag |
इस आइटम के लिए ETag. | |
html |
string |
इस आइटम के लिए एचटीएमएल कॉन्टेंट. अगर किसी आइटम के लिए text और html , दोनों दिए गए हैं, तो टाइमलाइन में html को रेंडर किया जाएगा. ऐसे एचटीएमएल एलिमेंट जिन्हें अनुमति दी गई है - आपके टाइमलाइन कार्ड में इन एलिमेंट का इस्तेमाल किया जा सकता है.
ब्लॉक किए गए एचटीएमएल एलिमेंट: ये एलिमेंट और इनका कॉन्टेंट, एचटीएमएल पेलोड से हटा दिया जाता है.
अन्य एलिमेंट: जो एलिमेंट सूची में नहीं हैं उन्हें हटा दिया जाता है, लेकिन उनका कॉन्टेंट सुरक्षित रखा जाता है. |
लिखा जा सकता है |
id |
string |
टाइमलाइन आइटम का आईडी. यह उपयोगकर्ता की टाइमलाइन में खास होता है. | |
inReplyTo |
string |
अगर इस आइटम को किसी दूसरे आइटम के जवाब के तौर पर जनरेट किया गया था, तो यह फ़ील्ड उस आइटम के आईडी पर सेट हो जाएगा जिसका जवाब दिया जा रहा है. इसका इस्तेमाल किसी बातचीत या पोस्ट का जवाब अटैच करने के लिए किया जा सकता है. | |
isBundleCover |
boolean |
क्या यह आइटम एक बंडल कवर है. अगर किसी आइटम को बंडल के कवर के तौर पर मार्क किया गया है, तो यह आइटम के उस बंडल का एंट्री पॉइंट होगा जिसकी कीमत उस आइटम के bundleId से मेल खाती है. इसे सिर्फ़ मुख्य टाइमलाइन पर दिखाया जाएगा — खुले बंडल में नहीं.मुख्य टाइमलाइन पर, दिखाए गए आइटम ये हैं:
|
लिखा जा सकता है |
isDeleted |
boolean |
अगर सही है, तो इससे पता चलता है कि इस आइटम को मिटा दिया गया है और सिर्फ़ आईडी प्रॉपर्टी सेट की गई है. | |
isPinned |
boolean |
सही होने पर, यह बताता है कि इस आइटम को पिन किया गया है. इसका मतलब है कि इसे "चालू है" के साथ ग्रुप किया गया है होम स्क्रीन के पीछे की ओर मौजूद, पुराने (पिन नहीं किए गए) टाइमलाइन आइटम से, नेविगेशन और Hangouts जैसे आइटम. उपयोगकर्ता को TOGGLE_PINNED में पहले से मौजूद मेन्यू आइटम के साथ, इस प्रॉपर्टी की वैल्यू को टॉगल करने की अनुमति दी जा सकती है. |
|
kind |
string |
संसाधन का टाइप. यह हमेशा mirror#timelineItem होता है. |
|
location |
nested object |
इस आइटम से जुड़ी भौगोलिक जगह. | लिखा जा सकता है |
menuItems[] |
list |
मेन्यू आइटम की एक सूची, जो उपयोगकर्ता को तब दिखाई जाएगी, जब टाइमलाइन में इस आइटम को चुना जाएगा. | लिखा जा सकता है |
menuItems[].action |
string |
यह नीति, उपयोगकर्ता के मेन्यू का विकल्प चुनने के बाद होने वाले व्यवहार को कंट्रोल करती है. स्वीकृत मान हैं:
|
लिखा जा सकता है |
menuItems[].id |
string |
इस मेन्यू आइटम का आईडी. इसे ऐप्लिकेशन से जनरेट किया जाता है और इसे ओपेक टोकन माना जाता है. | लिखा जा सकता है |
menuItems[].payload |
string |
यह एक सामान्य पेलोड है, जिसका मतलब इस मेन्यू आइटम की कार्रवाई के आधार पर बदलता है.
|
लिखा जा सकता है |
menuItems[].removeWhenSelected |
boolean |
अगर CUSTOM मेन्यू आइटम में 'सही है' पर सेट किया जाता है, तो उस आइटम को चुने जाने के बाद मेन्यू से हटा दिया जाएगा. |
लिखा जा सकता है |
menuItems[].values[] |
list |
CUSTOM आइटम के लिए, हर राज्य में मेन्यू आइटम के दिखाए जाने के तरीके को कंट्रोल करने वाली वैल्यू की सूची. DEFAULT राज्य के लिए वैल्यू देना ज़रूरी है. अगर PENDING या CONFIRMED स्थितियां मौजूद नहीं हैं, तो इन्हें नहीं दिखाया जाएगा. |
लिखा जा सकता है |
menuItems[].values[].displayName |
string |
मेन्यू आइटम के लिए दिखाया जाने वाला नाम. अगर इस प्रॉपर्टी को किसी बिल्ट-इन मेन्यू आइटम के लिए तय किया जाता है, तो उस मेन्यू आइटम के लिए डिफ़ॉल्ट तौर पर इस्तेमाल किया जाने वाला बोला गया निर्देश नहीं दिखाया जाता. | लिखा जा सकता है |
menuItems[].values[].iconUrl |
string |
मेन्यू आइटम के साथ दिखाए जाने वाले आइकॉन का यूआरएल. | लिखा जा सकता है |
menuItems[].values[].state |
string |
वह राज्य जिस पर यह वैल्यू लागू होती है. स्वीकृत मान हैं:
|
लिखा जा सकता है |
notification |
nested object |
यह नीति कंट्रोल करती है कि डिवाइस पर इस आइटम की सूचनाएं किस तरह दिखाई दें. यह जानकारी मौजूद न होने पर, कोई सूचना जनरेट नहीं की जाएगी. | लिखा जा सकता है |
notification.deliveryTime |
datetime |
सूचना भेजे जाने का समय. | लिखा जा सकता है |
notification.level |
string |
यह बताता है कि सूचना कितनी अहम है. स्वीकृत मान हैं:
|
लिखा जा सकता है |
pinScore |
integer |
पिन किए गए आइटम के लिए, यह टाइमलाइन में उस आइटम के दिखने का क्रम तय करता है और समय के करीब सबसे ज़्यादा स्कोर दिखाई देता है. ध्यान दें: फ़िलहाल, इस फ़ील्ड को सेट करने की सुविधा उपलब्ध नहीं है. | |
recipients[] |
list |
उन उपयोगकर्ताओं या ग्रुप की सूची जिनके साथ इस आइटम को शेयर किया गया है. | लिखा जा सकता है |
selfLink |
string |
वह यूआरएल जिसका इस्तेमाल इस आइटम को वापस पाने के लिए किया जा सकता है. | |
sourceItemId |
string |
ओपेक स्ट्रिंग का इस्तेमाल करके, टाइमलाइन आइटम को अपनी सेवा में मौजूद डेटा से मैप किया जा सकता है. | लिखा जा सकता है |
speakableText |
string |
इस आइटम के कॉन्टेंट का बोलने लायक वर्शन. READ_ALOUD मेन्यू आइटम के साथ, इस फ़ील्ड का इस्तेमाल वह टेक्स्ट देने के लिए करें जो ज़ोर से पढ़कर सुनाए जाने पर साफ़ दिखता हो. इसके अलावा, इसका इस्तेमाल Glass पर दिखाई जा रही चीज़ों के बारे में ज़्यादा जानकारी देने के लिए भी किया जा सकता है.ग्लासवेयर में SpeakingType फ़ील्ड को भी बताया जाना चाहिए. इस फ़ील्ड को इस टेक्स्ट से पहले उन मामलों में बोला जाएगा जहां अतिरिक्त जानकारी काम की हो. उदाहरण के लिए, जब उपयोगकर्ता किसी सूचना के बाद उस आइटम को ज़ोर से पढ़कर सुनाने का अनुरोध करता है. |
लिखा जा सकता है |
speakableType |
string |
इस आइटम के टाइप के बारे में बोलने लायक जानकारी. इसकी सूचना, किसी आइटम का कॉन्टेंट पढ़ने से पहले उपयोगकर्ता को दी जाएगी. ऐसा उन मामलों में होगा जहां ज़्यादा जानकारी काम की हो. उदाहरण के लिए, जब उपयोगकर्ता किसी सूचना के बाद, उस आइटम को ज़ोर से पढ़कर सुनाने का अनुरोध करता है, तो यह सूचना दी जाएगी. यह एक छोटा और आसान वाक्यांश होना चाहिए. जैसे, "ईमेल", "टेक्स्ट मैसेज" या "डेली प्लैनेट न्यूज़ अपडेट". हमारा सुझाव है कि टाइमलाइन पर मौजूद हर आइटम के लिए, कांच से बने इस फ़ील्ड में जानकारी डालें, भले ही आइटम में SpeakingText या टेक्स्ट शामिल न हो. इससे उपयोगकर्ता, स्क्रीन देखे बिना ही यह जान पाएगा कि आइटम किस तरह का है. |
लिखा जा सकता है |
text |
string |
इस आइटम का टेक्स्ट कॉन्टेंट. | लिखा जा सकता है |
title |
string |
इस आइटम का टाइटल. | लिखा जा सकता है |
updated |
datetime |
वह समय जब इस आइटम में आखिरी बार बदलाव किया गया था. यह आरएफ़सी 3339 के मुताबिक फ़ॉर्मैट किया गया था. |
तरीके
- मिटाएं
- टाइमलाइन से जुड़े आइटम को मिटाता है.
- पाएं
- आईडी के हिसाब से एक टाइमलाइन आइटम मिलता है.
- डालें
- टाइमलाइन में नया आइटम जोड़ता है.
- list
- पुष्टि किए गए उपयोगकर्ता के लिए, टाइमलाइन आइटम की सूची हासिल करता है.
- पैच
- टाइमलाइन से जुड़े आइटम को अपडेट करता है. यह तरीका, पैच सिमैंटिक्स के साथ काम करता है.
- अपडेट करें
- टाइमलाइन से जुड़े आइटम को अपडेट करता है.