Açıklama
Okuma Listesi'ndeki öğelerde okuma ve değişiklik yapmak için chrome.readingList
API'sini kullanın.
İzinler
readingList
Okuma Listesi API'sini kullanmak için manifest uzantı dosyasına "readingList"
iznini ekleyin:
manifest.json:
{
"name": "My reading list extension",
...
"permissions": [
"readingList"
]
}
Kullanılabilirlik
Chrome'da, yan panelde bir okuma listesi bulunur. Kullanıcıların web sayfalarını daha sonra veya çevrimdışıyken okumak üzere kaydetmelerine olanak tanır. Mevcut öğeleri almak ve listeye öğe eklemek veya listeden öğe kaldırmak için Okuma Listesi API'sini kullanın.
Kavramlar ve kullanım
Ürün sıralaması
Okuma listesindeki öğeler, garanti edilen bir sırada değildir.
Öğe benzersizliği
Öğeler URL ile gösterilir. Karma ve sorgu dizesi dahildir.
Kullanım alanları
Aşağıdaki bölümlerde, Okuma Listesi API'si için bazı yaygın kullanım örnekleri gösterilmektedir. Uzantı örneklerinin tamamı için Uzantı örnekleri bölümüne bakın.
Öğe ekleyin
Okuma listesine bir öğe eklemek için chrome.readingList.addEntry()
işlevini kullanın:
chrome.readingList.addEntry({
title: "New to the web platform in September | web.dev",
url: "https://developer.chrome.com/",
hasBeenRead: false
});
Öğeleri göster
Okuma listesindeki öğeleri görüntülemek için chrome.readingList.query()
yöntemini kullanarak bu öğeleri alın.
yöntemidir.
const items = await chrome.readingList.query({});
for (const item of items) {
// Do something do display the item
}
Öğeleri okundu olarak işaretleme
Başlık, URL ve okunma durumunu güncellemek için chrome.readingList.updateEntry()
aracını kullanabilirsiniz. Aşağıdaki kodla bir öğe okundu olarak işaretlenir:
chrome.readingList.updateEntry({
url: "https://developer.chrome.com/",
hasBeenRead: true
});
Öğe kaldırma
Bir öğeyi kaldırmak için chrome.readingList.removeEntry()
işlevini kullanın:
chrome.readingList.removeEntry({
url: "https://developer.chrome.com/"
});
Uzantı örnekleri
Daha fazla Okuma Listesi API'sı uzantı demoları için Okuma Listesi API'si örneğine bakın.
Türler
AddEntryOptions
Özellikler
-
hasBeenRead
boolean
Giriş okunmuşsa
true
olur. -
title
dize
Girişin başlığı.
-
url
dize
Girişin URL'si.
QueryInfo
Özellikler
-
hasBeenRead
boole isteğe bağlı
Okunmuş (
true
) veya okunmamış (false
) öğelerin aranacağını belirtir. -
title
dize isteğe bağlı
Aranacak başlık.
-
url
dize isteğe bağlı
Aranacak bir URL.
ReadingListEntry
Özellikler
-
creationTime
sayı
Girişin oluşturulduğu zaman. 1 Ocak 1970'ten itibaren milisaniye cinsinden kaydedildi.
-
hasBeenRead
boolean
Giriş okunmuşsa
true
olur. -
lastUpdateTime
sayı
Girişin en son güncellendiği zaman. Bu değer, 1 Ocak 1970 tarihinden itibaren milisaniye cinsindendir.
-
title
dize
Girişin başlığı.
-
url
dize
Girişin URL'si.
RemoveOptions
Özellikler
-
url
dize
Kaldırılacak URL.
UpdateEntryOptions
Özellikler
-
hasBeenRead
boole isteğe bağlı
Güncellenen okunma durumu. Değer sağlanmazsa mevcut durum kalır.
-
title
dize isteğe bağlı
Yeni başlık. Değer sağlanmazsa mevcut kutu kalır.
-
url
dize
Güncellenecek URL.
Yöntemler
addEntry()
chrome.readingList.addEntry(
entry: AddEntryOptions,
callback?: function,
)
Mevcut olmayan bir girişi okuma listesine ekler.
Parametreler
-
giriş
Okuma listesine eklenecek giriş.
-
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:() => void
İadeler
-
Taahhüt<void>
Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.
query()
chrome.readingList.query(
info: QueryInfo,
callback?: function,
)
QueryInfo
özellikleriyle eşleşen tüm girişleri alır. Sağlanmayan tesisler eşleştirilmez.
Parametreler
-
bilgi
Aranacak özellikler.
-
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(entries: ReadingListEntry[]) => void
-
entries
-
İadeler
-
Promise<ReadingListEntry[]>
Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.
removeEntry()
chrome.readingList.removeEntry(
info: RemoveOptions,
callback?: function,
)
Okuma listesindeki bir girişi (varsa) kaldırır.
Parametreler
-
bilgi
Okuma listesinden kaldırılacak giriş.
-
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:() => void
İadeler
-
Taahhüt<void>
Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.
updateEntry()
chrome.readingList.updateEntry(
info: UpdateEntryOptions,
callback?: function,
)
Varsa bir okuma listesi girişini günceller.
Parametreler
-
bilgi
Güncellenecek giriş.
-
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:() => void
İadeler
-
Taahhüt<void>
Manifest V3 ve sonraki sürümlerde vaatler desteklenir ancak geriye dönük uyumluluk Aynı işlev çağrısında ikisini birden kullanamazsınız. İlgili içeriği oluşturmak için kullanılan taahhüt, geri çağırmaya iletilen aynı türle çözümlenir.
Etkinlikler
onEntryAdded
chrome.readingList.onEntryAdded.addListener(
callback: function,
)
Okuma listesine ReadingListEntry
eklendiğinde tetiklenir.
Parametreler
-
geri çağırma
işlev
callback
parametresi şu şekilde görünür:(entry: ReadingListEntry) => void
-
giriş
-
onEntryRemoved
chrome.readingList.onEntryRemoved.addListener(
callback: function,
)
Okuma listesinden bir ReadingListEntry
kaldırıldığında tetiklenir.
Parametreler
-
geri çağırma
işlev
callback
parametresi şu şekilde görünür:(entry: ReadingListEntry) => void
-
giriş
-
onEntryUpdated
chrome.readingList.onEntryUpdated.addListener(
callback: function,
)
Okuma listesinde bir ReadingListEntry
güncellendiğinde tetiklenir.
Parametreler
-
geri çağırma
işlev
callback
parametresi şu şekilde görünür:(entry: ReadingListEntry) => void
-
giriş
-