chrome.readingList

Açıklama

chrome.readingList API'yi kullanarak Okuma Listesi'ndeki öğeleri okuyun ve değiştirin.

İzinler

readingList

Okuma Listesi API'sini kullanmak için uzantı manifest 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ı kaydedip daha sonra veya çevrimdışıyken okumasına olanak tanır. Mevcut öğeleri almak ve listeye öğe eklemek veya listeden öğe kaldırmak için Okuma Listesi API'sini kullanın.

Bir dizi makalenin gösterildiği 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 gösterilmez.

Öğenin benzersizliği

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

Kullanım alanları

Aşağıdaki bölümlerde, Okuma Listesi API'sinin 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
});

Görüntülenen öğeler

Okuma listesindeki öğeleri görüntülemek için chrome.readingList.query() yöntemini kullanarak öğeleri alı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 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

Öğeleri kaldırmak için chrome.readingList.removeEntry() simgesini kullanın:

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

Uzantı örnekleri

Daha fazla Okuma Listesi API'si uzantısı demosu için Okuma Listesi API'si ö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

    boolean isteğe bağlı

    Okunmuş (true) veya okunmamış (false) öğelerin aranıp aranmayacağı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 kaydedilir.

  • hasBeenRead

    boolean

    Giriş okunduysa true olur.

  • lastUpdateTime

    sayı

    Girişin son güncellenme zamanı. Bu değer, 1 Ocak 1970'ten 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

    boolean 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 kutucuk kalır.

  • url

    dize

    Güncellenecek URL.

Yöntemler

addEntry()

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

Okuma listesinde yoksa bir giriş ekler.

Parametreler

İadeler

  • Promise<void>

query()

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

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

Varsa okuma listesinden bir girişi kaldırır.

Parametreler

İadeler

  • Promise<void>

updateEntry()

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

Varsa okuma listesi girişini günceller.

Parametreler

İadeler

  • Promise<void>

Etkinlikler

onEntryAdded

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

Okuma listesine ReadingListEntry eklendiğinde tetiklenir.

Parametreler

onEntryRemoved

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

Bir ReadingListEntry okuma listesinden kaldırıldığında tetiklenir.

Parametreler

onEntryUpdated

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

Okuma listesinde bir ReadingListEntry güncellendiğinde tetiklenir.

Parametreler