browser.readingList

ब्यौरा

रीडिंग लिस्ट में मौजूद आइटम को पढ़ने और उनमें बदलाव करने के लिए, chrome.readingList API का इस्तेमाल करें.

अनुमतियां

readingList

रीडिंग लिस्ट एपीआई का इस्तेमाल करने के लिए, एक्सटेंशन की मेनिफ़ेस्ट फ़ाइल में "readingList" अनुमति जोड़ें:

manifest.json:

{
  "name": "My reading list extension",
  ...
  "permissions": [
    "readingList"
  ]
}

उपलब्धता

Chrome 120+ ब्राउज़र.* Chrome 148 से MV3+

Chrome के साइड पैनल में रीडिंग लिस्ट की सुविधा होती है. इससे उपयोगकर्ता, वेब पेजों को बाद में या ऑफ़लाइन मोड में पढ़ने के लिए सेव कर सकते हैं. Reading List API का इस्तेमाल करके, मौजूदा आइटम वापस पाएं. साथ ही, सूची में आइटम जोड़ें या हटाएं.

रीडिंग लिस्ट में कई लेख दिख रहे हैं
रीडिंग लिस्ट में कई लेख दिख रहे हैं

कॉन्सेप्ट और इस्तेमाल

आइटम को क्रम से लगाना

रीडिंग लिस्ट में मौजूद आइटम किसी तय क्रम में नहीं होते.

आइटम की खासियत

आइटम को यूआरएल के हिसाब से इंडेक्स किया जाता है. इसमें हैश और क्वेरी स्ट्रिंग शामिल होती है.

उपयोग के उदाहरण

यहां दिए गए सेक्शन में, Reading List API के इस्तेमाल के कुछ सामान्य उदाहरण दिए गए हैं. एक्सटेंशन के पूरे उदाहरण देखने के लिए, एक्सटेंशन के सैंपल देखें.

कोई आइटम जोड़ें

रीडिंग लिस्ट में कोई आइटम जोड़ने के लिए, browser.readingList.addEntry() का इस्तेमाल करें:

browser.readingList.addEntry({
  title: "New to the web platform in September | web.dev",
  url: "https://developer.chrome.com/",
  hasBeenRead: false
});

आइटम दिखाएं

रीडिंग लिस्ट में मौजूद आइटम दिखाने के लिए, उन्हें वापस पाने के लिए browser.readingList.query() तरीके का इस्तेमाल करें.

const items = await browser.readingList.query({});

for (const item of items) {
  // Do something do display the item
}

किसी आइटम को 'पढ़ा गया' के तौर पर मार्क करना

टाइटल, यूआरएल, और पढ़ने की स्थिति को अपडेट करने के लिए, browser.readingList.updateEntry() का इस्तेमाल किया जा सकता है. नीचे दिए गए कोड से, किसी आइटम को 'पढ़ा गया' के तौर पर मार्क किया जाता है:

browser.readingList.updateEntry({
  url: "https://developer.chrome.com/",
  hasBeenRead: true
});

कोई आइटम हटाना

किसी आइटम को हटाने के लिए, browser.readingList.removeEntry() का इस्तेमाल करें:

browser.readingList.removeEntry({
  url: "https://developer.chrome.com/"
});

एक्सटेंशन के सैंपल

रीडिंग लिस्ट एपीआई एक्सटेंशन के ज़्यादा डेमो देखने के लिए, रीडिंग लिस्ट एपीआई का सैंपल देखें.

टाइप

AddEntryOptions

प्रॉपर्टी

  • hasBeenRead

    बूलियन

    अगर एंट्री को पढ़ लिया गया है, तो यह true होगी.

  • title

    स्ट्रिंग

    एंट्री का टाइटल.

  • url

    स्ट्रिंग

    एंट्री का यूआरएल.

QueryInfo

प्रॉपर्टी

  • hasBeenRead

    बूलियन ज़रूरी नहीं

    इससे पता चलता है कि पढ़े गए (true) या नहीं पढ़े गए (false) आइटम खोजने हैं या नहीं.

  • title

    string ज़रूरी नहीं

    खोजने के लिए कोई टाइटल.

  • url

    string ज़रूरी नहीं

    खोजने के लिए यूआरएल.

ReadingListEntry

प्रॉपर्टी

  • creationTime

    संख्या

    एंट्री बनाने का समय. इसे 1 जनवरी, 1970 से मिलीसेकंड में रिकॉर्ड किया जाता है.

  • hasBeenRead

    बूलियन

    अगर एंट्री को पढ़ लिया गया है, तो यह true होगी.

  • lastUpdateTime

    संख्या

    एंट्री को आखिरी बार अपडेट किए जाने की तारीख. यह वैल्यू, 1 जनवरी, 1970 से मिलीसेकंड में दी जाती है.

  • title

    स्ट्रिंग

    एंट्री का टाइटल.

  • url

    स्ट्रिंग

    एंट्री का यूआरएल.

RemoveOptions

प्रॉपर्टी

  • url

    स्ट्रिंग

    हटाया जाने वाला यूआरएल.

UpdateEntryOptions

प्रॉपर्टी

  • hasBeenRead

    बूलियन ज़रूरी नहीं

    ईमेल पढ़े जाने से जुड़ी अपडेट की गई स्थिति. अगर कोई वैल्यू नहीं दी जाती है, तो मौजूदा स्थिति बनी रहती है.

  • title

    string ज़रूरी नहीं

    नया टाइटल. अगर कोई वैल्यू नहीं दी जाती है, तो मौजूदा टाइल बनी रहती है.

  • url

    स्ट्रिंग

    वह यूआरएल जिसे अपडेट किया जाएगा.

तरीके

addEntry()

browser.readingList.addEntry(
  entry: AddEntryOptions,
): Promise<void>

अगर रीडिंग लिस्ट में कोई एंट्री मौजूद नहीं है, तो उसे जोड़ता है.

पैरामीटर

  • एंट्री

    AddEntryOptions

    रीडिंग लिस्ट में जोड़ने के लिए एंट्री.

रिटर्न

  • वादा<शून्य>

    एंट्री जोड़ने के बाद, यह समस्या हल हो जाती है.

query()

browser.readingList.query(
  info: QueryInfo,
): Promise<ReadingListEntry[]>

यह फ़ंक्शन, QueryInfo प्रॉपर्टी से मैच होने वाली सभी एंट्री को वापस लाता है. जिन प्रॉपर्टी की जानकारी नहीं दी गई है उन्हें मैच नहीं किया जाएगा.

पैरामीटर

  • जानकारी

    QueryInfo

    खोजने के लिए प्रॉपर्टी.

रिटर्न

  • Promise<ReadingListEntry[]>

    एंट्री मैच होने के बाद, यह समस्या हल हो जाती है.

removeEntry()

browser.readingList.removeEntry(
  info: RemoveOptions,
): Promise<void>

अगर रीडिंग लिस्ट में कोई एंट्री मौजूद है, तो उसे हटाता है.

पैरामीटर

  • जानकारी

    RemoveOptions

    रीडिंग लिस्ट से हटाई जाने वाली एंट्री.

रिटर्न

  • वादा<शून्य>

    एंट्री हटाए जाने के बाद, यह समस्या हल हो जाती है.

updateEntry()

browser.readingList.updateEntry(
  info: UpdateEntryOptions,
): Promise<void>

अगर रीडिंग लिस्ट में कोई एंट्री मौजूद है, तो उसे अपडेट करता है.

पैरामीटर

  • जानकारी

    UpdateEntryOptions

    अपडेट की जाने वाली एंट्री.

रिटर्न

  • वादा<शून्य>

    मैच होने वाली एंट्री अपडेट होने के बाद, यह समस्या हल हो जाती है.

इवेंट

onEntryAdded

browser.readingList.onEntryAdded.addListener(
  callback: function,
)

रीडिंग लिस्ट में ReadingListEntry जोड़ने पर ट्रिगर होता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (entry: ReadingListEntry) => void

onEntryRemoved

browser.readingList.onEntryRemoved.addListener(
  callback: function,
)

यह तब ट्रिगर होता है, जब किसी ReadingListEntry को रीडिंग लिस्ट से हटाया जाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (entry: ReadingListEntry) => void

onEntryUpdated

browser.readingList.onEntryUpdated.addListener(
  callback: function,
)

रीडिंग लिस्ट में ReadingListEntry अपडेट होने पर ट्रिगर होता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (entry: ReadingListEntry) => void