browser.readingList

Açıklama

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

İzinler

readingList

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

manifest.json:

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

Kullanılabilirlik

Chrome 120 ve sonraki sürümler Chrome 148'den itibaren browser.* MV3 ve sonraki sürümler

Chrome'un yan panelinde bir okuma listesi bulunur. Kullanıcıların web sayfalarını daha sonra veya çevrimdışıyken okumak üzere kaydetmesine olanak tanır. Mevcut öğeleri almak ve listeye öğe eklemek veya listeden öğe kaldırmak için Reading List API'yi kullanın.

Bir dizi makaleyi gösteren okuma listesi
Bir dizi makalenin gösterildiği okuma listesi

Kavramlar ve kullanım

Öğe sıralaması

Okuma listesindeki öğeler belirli bir sıraya göre dizilmez.

Öğenin benzersizliği

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

Kullanım alanları

Aşağıdaki bölümlerde, Reading List API'nin 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 öğe eklemek için browser.readingList.addEntry() kısayolunu kullanın:

browser.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 browser.readingList.query() yöntemini kullanarak öğeleri alın. yöntemini kullanın.

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

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

Bir öğeyi okundu olarak işaretleme

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

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

Öğe kaldırma

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

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

Uzantı örnekleri

Reading List API uzantılarıyla ilgili daha fazla demo için Reading List API örneğine bakın.

Türler

AddEntryOptions

Özellikler

  • hasBeenRead

    boole

    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 aranıp aranmayacağını belirtir.

  • title

    string isteğe bağlı

    Aranacak 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 itibaren milisaniye cinsinden kaydedilir.

  • hasBeenRead

    boole

    Giriş okunduysa true olur.

  • lastUpdateTime

    sayı

    Girişin son güncellendiği zaman. Bu değer, 1 Ocak 1970'ten itibaren milisaniye cinsinden hesaplanı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 okundu durumu. Değer sağlanmazsa mevcut durum korunur.

  • title

    string isteğe bağlı

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

  • url

    dize

    Güncellenecek URL.

Yöntemler

addEntry()

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

Okuma listesine bir giriş ekler (mevcut değilse).

Parametreler

İadeler

  • Promise<void>

    Giriş eklendikten sonra çözümlenir.

query()

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

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

Parametreler

İadeler

removeEntry()

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

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

Parametreler

İadeler

  • Promise<void>

    Giriş kaldırıldığında sorun çözülür.

updateEntry()

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

Varsa okuma listesi girişini günceller.

Parametreler

İadeler

  • Promise<void>

    Eşleşen girişler güncellendikten sonra çözümlenir.

Etkinlikler

onEntryAdded

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

Okuma listesine bir ReadingListEntry eklendiğinde tetiklenir.

Parametreler

onEntryRemoved

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

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

Parametreler

onEntryUpdated

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

Okuma listesinde bir ReadingListEntry güncellendiğinde tetiklenir.

Parametreler