chrome.readingList

ब्यौरा

अनुमतियां

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

manifest.json:

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

उपलब्धता

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

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

आइटम ऑर्डर करना

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

प्रॉडक्ट की यूनीकनेस

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

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

यहां दिए गए सेक्शन में, 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/"
});

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

Reading List API एक्सटेंशन के अन्य डेमो देखने के लिए, Reading List API का सैंपल देखें.

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

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

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

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

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

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

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