chrome.readingList

Açıklama

Okuma Listesi'ndeki öğeleri okumak ve değiştirmek için chrome.readingList API'yi 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 120+ MV3+

Chrome'da, 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 makaleleri gösteren okuma listesi
Çeşitli makaleleri gösteren okuma listesi

Kavramlar ve kullanım

Öğe 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'sinin bazı yaygın kullanım alanları gösterilmektedir. Eksiksiz uzantı örnekleri 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ığı, URL'yi ve okuma 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() işlevini kullanın:

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

Uzantı örnekleri

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

Türler

AddEntryOptions

Özellikler

  • hasBeenRead

    boolean

    Giriş okunmuşsa true olur.

  • title

    dize

    Girişin başlığı.

  • url

    dize

    Girişte belirtilen URL.

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 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'den itibaren milisaniye cinsindendir.

  • title

    dize

    Girişin başlığı.

  • url

    dize

    Girişte belirtilen URL.

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 korunur.

  • title

    dize isteğe bağlı

    Yeni başlık. Değer sağlanmazsa mevcut karo kalır.

  • url

    dize

    Güncellenecek URL.

Yöntemler

addEntry()

Promise 'nı inceleyin.
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

Okuma listesi yoksa okuma listesine bir giriş ekler.

Parametreler

  • Okuma listesine eklenecek giriş.

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Promise<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()

Promise 
chrome.readingList.query(
  info: QueryInfo,
  callback?: function,
)

QueryInfo mülkleriyle eşleşen tüm girişleri alır. Sağlanmayan özellikler eşleştirilmez.

Parametreler

İ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()

Promise 'nı inceleyin.
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

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

Parametreler

  • 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

  • Promise&lt;void&gt;

    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()

Promise 
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

Varsa bir okuma listesi girişini günceller.

Parametreler

  • Güncellenecek giriş.

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Promise&lt;void&gt;

    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. Sözleşme, geri çağırma işlevine iletilen türle çözülür.

Etkinlikler

onEntryAdded

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

Okuma listesine bir ReadingListEntry eklendiğinde tetiklenir.

Parametreler

onEntryRemoved

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

Okuma listesinden bir ReadingListEntry kaldırıldığında tetiklenir.

Parametreler

onEntryUpdated

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

Okuma listesinde bir ReadingListEntry güncellendiğinde tetiklenir.

Parametreler