ब्यौरा
रीडिंग लिस्ट में आइटम पढ़ने और उनमें बदलाव करने के लिए, chrome.readingList
एपीआई का इस्तेमाल करें.
अनुमतियां
readingList
रीडिंग लिस्ट एपीआई का इस्तेमाल करने के लिए, एक्सटेंशन मेनिफ़ेस्ट फ़ाइल में "readingList"
की अनुमति जोड़ें:
manifest.json:
{
"name": "My reading list extension",
...
"permissions": [
"readingList"
]
}
उपलब्धता
Chrome में साइड पैनल में रीडिंग लिस्ट की सुविधा होती है. इससे उपयोगकर्ता, वेब पेजों को बाद में या ऑफ़लाइन मोड में पढ़ने के लिए सेव कर सकते हैं. मौजूदा आइटम वापस पाने और सूची में आइटम जोड़ने या हटाने के लिए, Reading List API का इस्तेमाल करें.
![रीडिंग लिस्ट में कई लेख दिख रहे हैं](https://developer.chrome.com/static/docs/extensions/reference/api/readingList/image/reading-list-showing-num-a0718c5ab1fe5.png?authuser=7&hl=hi)
सिद्धांत और इस्तेमाल
आइटम का ऑर्डर
रीडिंग लिस्ट में मौजूद आइटम, किसी भी क्रम में नहीं हैं.
आइटम की खासियत
आइटम की सुरक्षा यूआरएल की मदद से की जाती है. इसमें हैश और क्वेरी स्ट्रिंग शामिल हैं.
इस्तेमाल के उदाहरण
नीचे दिए गए सेक्शन में, Reading List API के इस्तेमाल के कुछ सामान्य उदाहरण दिए गए हैं. एक्सटेंशन के पूरे उदाहरणों के लिए, एक्सटेंशन के सैंपल देखें.
कोई आइटम जोड़ें
रीडिंग लिस्ट में किसी आइटम को जोड़ने के लिए, chrome.readingList.addEntry()
का इस्तेमाल करें:
chrome.readingList.addEntry({
title: "New to the web platform in September | web.dev",
url: "https://developer.chrome.com/",
hasBeenRead: false
});
डिसप्ले आइटम
रीडिंग लिस्ट से आइटम देखने के लिए, उन्हें वापस पाने के लिए chrome.readingList.query()
तरीका इस्तेमाल करें.
तरीका.
const items = await chrome.readingList.query({});
for (const item of items) {
// Do something do display the item
}
किसी आइटम पर 'पढ़ा गया' का निशान लगाना
टाइटल, यूआरएल, और पढ़े जाने की स्थिति को अपडेट करने के लिए, chrome.readingList.updateEntry()
का इस्तेमाल किया जा सकता है. यह कोड, एक आइटम को 'पढ़ा गया' के तौर पर मार्क करता है:
chrome.readingList.updateEntry({
url: "https://developer.chrome.com/",
hasBeenRead: true
});
कोई आइटम हटाना
किसी आइटम को हटाने के लिए, chrome.readingList.removeEntry()
का इस्तेमाल करें:
chrome.readingList.removeEntry({
url: "https://developer.chrome.com/"
});
एक्सटेंशन के सैंपल
रीडिंग लिस्ट एपीआई के एक्सटेंशन के ज़्यादा डेमो के लिए, रीडिंग लिस्ट एपीआई सैंपल देखें.
टाइप
AddEntryOptions
प्रॉपर्टी
-
hasBeenRead
boolean
अगर एंट्री पढ़ ली गई है, तो
true
होगा. -
title
स्ट्रिंग
एंट्री का टाइटल.
-
यूआरएल
स्ट्रिंग
एंट्री का यूआरएल.
QueryInfo
प्रॉपर्टी
-
hasBeenRead
बूलियन ज़रूरी नहीं
बताता है कि पढ़े गए (
true
) या अपठित (false
) आइटम खोजना है या नहीं. -
title
स्ट्रिंग ज़रूरी नहीं
खोजने के लिए शीर्षक.
-
यूआरएल
स्ट्रिंग ज़रूरी नहीं
खोजने के लिए यूआरएल.
ReadingListEntry
प्रॉपर्टी
-
creationTime
नंबर
एंट्री बनाए जाने का समय. 1 जनवरी, 1970 से मिलीसेकंड में रिकॉर्ड किया गया.
-
hasBeenRead
boolean
अगर एंट्री पढ़ ली गई है, तो
true
होगा. -
lastUpdateTime
नंबर
एंट्री को पिछली बार अपडेट किए जाने का समय. यह मान 1 जनवरी, 1970 से मिलीसेकंड में है.
-
title
स्ट्रिंग
एंट्री का टाइटल.
-
यूआरएल
स्ट्रिंग
एंट्री का यूआरएल.
RemoveOptions
प्रॉपर्टी
-
यूआरएल
स्ट्रिंग
हटाया जाने वाला यूआरएल.
UpdateEntryOptions
प्रॉपर्टी
-
hasBeenRead
बूलियन ज़रूरी नहीं
अपडेट किया गया 'पढ़ा गया' का स्टेटस. वैल्यू न देने पर, मौजूदा स्थिति बनी रहती है.
-
title
स्ट्रिंग ज़रूरी नहीं
नया टाइटल. वैल्यू न देने पर, मौजूदा टाइल बनी रहती है.
-
यूआरएल
स्ट्रिंग
अपडेट किया जाने वाला यूआरएल.
तरीके
addEntry()
chrome.readingList.addEntry(
entry: AddEntryOptions,
callback?: function,
)
रीडिंग लिस्ट में एंट्री मौजूद न होने पर, उसे जोड़ता है.
पैरामीटर
-
एंट्री
रीडिंग लिस्ट में जोड़ने के लिए एंट्री.
-
कॉलबैक
फ़ंक्शन ज़रूरी नहीं
callback
पैरामीटर ऐसा दिखता है:() => void
रिटर्न
-
Promise<void>
प्रॉमिस, मेनिफ़ेस्ट V3 और इसके बाद के वर्शन में काम करता है. हालांकि, पुराने सिस्टम के साथ काम करने के लिए कॉलबैक दिए जाते हैं. आप एक ही फ़ंक्शन कॉल पर दोनों का इस्तेमाल नहीं कर सकते. प्रॉमिस उसी टाइप के साथ रिज़ॉल्व हो जाती है जिसे कॉलबैक को पास किया जाता है.
query()
chrome.readingList.query(
info: QueryInfo,
callback?: function,
)
QueryInfo
प्रॉपर्टी से मेल खाने वाली सभी एंट्री वापस लाता है. जो प्रॉपर्टी नहीं दी गई हैं उनका मिलान नहीं किया जाएगा.
पैरामीटर
-
जानकारी
खोजी जाने वाली प्रॉपर्टी.
-
कॉलबैक
फ़ंक्शन ज़रूरी नहीं
callback
पैरामीटर ऐसा दिखता है:(entries: ReadingListEntry[]) => void
-
एंट्री
-
रिटर्न
-
Promise<ReadingListEntry[]>
प्रॉमिस, मेनिफ़ेस्ट V3 और इसके बाद के वर्शन में काम करता है. हालांकि, पुराने सिस्टम के साथ काम करने के लिए कॉलबैक दिए जाते हैं. आप एक ही फ़ंक्शन कॉल पर दोनों का इस्तेमाल नहीं कर सकते. प्रॉमिस उसी टाइप के साथ रिज़ॉल्व हो जाती है जिसे कॉलबैक को पास किया जाता है.
removeEntry()
chrome.readingList.removeEntry(
info: RemoveOptions,
callback?: function,
)
कोई एंट्री मौजूद होने पर, उसे रीडिंग लिस्ट से हटा दिया जाता है.
पैरामीटर
-
जानकारी
रीडिंग लिस्ट से हटाई जाने वाली एंट्री.
-
कॉलबैक
फ़ंक्शन ज़रूरी नहीं
callback
पैरामीटर ऐसा दिखता है:() => void
रिटर्न
-
Promise<void>
प्रॉमिस, मेनिफ़ेस्ट V3 और इसके बाद के वर्शन में काम करता है. हालांकि, पुराने सिस्टम के साथ काम करने के लिए कॉलबैक दिए जाते हैं. आप एक ही फ़ंक्शन कॉल पर दोनों का इस्तेमाल नहीं कर सकते. प्रॉमिस उसी टाइप के साथ रिज़ॉल्व हो जाती है जिसे कॉलबैक को पास किया जाता है.
updateEntry()
chrome.readingList.updateEntry(
info: UpdateEntryOptions,
callback?: function,
)
रीडिंग लिस्ट की एंट्री मौजूद होने पर, उसे अपडेट करता है.
पैरामीटर
-
जानकारी
अपडेट की जाने वाली एंट्री.
-
कॉलबैक
फ़ंक्शन ज़रूरी नहीं
callback
पैरामीटर ऐसा दिखता है:() => void
रिटर्न
-
Promise<void>
प्रॉमिस, मेनिफ़ेस्ट V3 और इसके बाद के वर्शन में काम करता है. हालांकि, पुराने सिस्टम के साथ काम करने के लिए कॉलबैक दिए जाते हैं. आप एक ही फ़ंक्शन कॉल पर दोनों का इस्तेमाल नहीं कर सकते. प्रॉमिस उसी टाइप के साथ रिज़ॉल्व हो जाती है जिसे कॉलबैक को पास किया जाता है.
इवेंट
onEntryAdded
chrome.readingList.onEntryAdded.addListener(
callback: function,
)
तब ट्रिगर होता है, जब ReadingListEntry
को रीडिंग लिस्ट में जोड़ा जाता है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callback
पैरामीटर ऐसा दिखता है:(entry: ReadingListEntry) => void
-
एंट्री
-
onEntryRemoved
chrome.readingList.onEntryRemoved.addListener(
callback: function,
)
तब ट्रिगर होता है, जब ReadingListEntry
को रीडिंग लिस्ट से हटा दिया जाता है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callback
पैरामीटर ऐसा दिखता है:(entry: ReadingListEntry) => void
-
एंट्री
-
onEntryUpdated
chrome.readingList.onEntryUpdated.addListener(
callback: function,
)
रीडिंग लिस्ट में किसी ReadingListEntry
को अपडेट किए जाने पर ट्रिगर होता है.
पैरामीटर
-
कॉलबैक
फ़ंक्शन
callback
पैरामीटर ऐसा दिखता है:(entry: ReadingListEntry) => void
-
एंट्री
-