chrome.readingList

Açıklama

Okuma Listesi'ndeki öğeleri okumak ve değiştirmek için chrome.readingList API'sini kullanın.

İzinler

readingList

Read List API'yi kullanmak için "readingList" iznini manifest uzantısına ekleyin:

manifest.json:

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

Kullanılabildiği yerler

Chrome 120 ve üzeri MV3 ve üzeri

Chrome'un yan panelde bir okuma listesi bulunur. Kullanıcıların web sayfalarını daha sonra veya çevrimdışıyken okumak için kaydetmelerine olanak tanır. Mevcut öğeleri almak ve listeye öğe eklemek veya listeden öğe kaldırmak için Okuma Listesi API'sini kullanın.

Çeşitli makalelerin gösterildiği okuma listesi
Birkaç makalenin gösterildiği okuma listesi

Kavramlar ve kullanım

Ürün sıralaması

Okuma listesindeki öğeler garantili bir sırada değildir.

Öğe benzersizliği

Öğeler URL'ye göre ayarlanır. Karma ve sorgu dizesi de buna dahildir.

Kullanım alanları

Aşağıdaki bölümlerde, Read List API'nin bazı yaygın kullanım alanları gösterilmektedir. Uzantı örneklerinin tamamı için Uzantı örnekleri bölümüne bakın.

Öğe ekleyin

Okuma listesine öğe eklemek için chrome.readingList.addEntry() simgesini kullanın:

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

Öğeleri görüntüleme

Okuma listesindeki öğeleri görüntülemek için bu öğeleri almak üzere chrome.readingList.query() yöntemini kullanın.

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

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

Bir öğeyi okundu olarak işaretleme

Başlığı, URL'yi ve okunma durumunu güncellemek için chrome.readingList.updateEntry() simgesini kullanabilirsiniz. Aşağıdaki kod bir öğeyi okundu olarak işaretler:

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

Öğe kaldırma

Bir öğeyi kaldırmak için chrome.readingList.removeEntry() simgesini kullanın:

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

Uzantı örnekleri

Daha fazla Reading List API uzantısı demosu için Reading List API örneğine bakın.

Türler

AddEntryOptions

Özellikler

  • hasBeenRead

    boolean

    Giriş okunduysa 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 mi aranacağını belirtir.

  • title

    string isteğe bağlı

    Aranacak bir başlık.

  • url

    string isteğe bağlı

    Aranacak URL.

ReadingListEntry

Özellikler

  • creationTime

    sayı

    Girişin oluşturulduğu zaman. 1 Ocak 1970'ten beri milisaniyeler içinde kayıt altına alınmıştır.

  • hasBeenRead

    boolean

    Giriş okunduysa true olur.

  • lastUpdateTime

    sayı

    Girişin en son güncellendiği zaman. Bu değer, 1 Ocak 1970 tarihinden itibaren milisaniye cinsinden kullanılmaktadır.

  • 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. Bir değer sağlanmazsa mevcut durum kalır.

  • title

    string isteğe bağlı

    Yeni başlık. Bir değer sağlanmazsa mevcut kutucuk kalır.

  • url

    dize

    Güncellenecek URL.

Yöntemler

addEntry()

Söz 
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

Mevcut olmayan bir girişi okuma listesine ekler.

Parametreler

  • Okuma listesine eklenecek giriş.

  • geri çağırma

    Functions (isteğe bağlı)

    callback parametresi şu şekilde görünür: 

    ()=>void

İlerlemeler

  • Promise<void>

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

query()

Söz 
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

İlerlemeler

  • Promise<ReadingListEntry[]>

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

removeEntry()

Söz 
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

Okuma listesinden (varsa) bir girişi kaldırır.

Parametreler

  • Okuma listesinden kaldırılacak giriş.

  • geri çağırma

    Functions (isteğe bağlı)

    callback parametresi şu şekilde görünür: 

    ()=>void

İlerlemeler

  • Promise<void>

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

updateEntry()

Söz 
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

Varsa okuma listesi girişini günceller.

Parametreler

  • Güncellenecek giriş.

  • geri çağırma

    Functions (isteğe bağlı)

    callback parametresi şu şekilde görünür: 

    ()=>void

İlerlemeler

  • Promise<void>

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

Etkinlikler

onEntryAdded

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

Okuma listesine ReadingListEntry eklendiğinde tetiklenir.

Parametreler

onEntryRemoved

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

Okuma listesinden ReadingListEntry çıkarıldığında tetiklenir.

Parametreler

onEntryUpdated

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

Okuma listesindeki bir ReadingListEntry güncellendiğinde tetiklenir.

Parametreler