chrome.readingList

Opis

Do odczytywania i modyfikowania elementów na liście Do przeczytania używaj interfejsu API chrome.readingList.

Uprawnienia

readingList

Aby używać interfejsu Reading List API, dodaj uprawnienie "readingList" do pliku manifest rozszerzenia:

manifest.json:

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

Dostępność

Chrome 120 i nowsze MV3 i nowsze

Chrome udostępnia listę Do przeczytania w panelu bocznym. Pozwala użytkownikom zapisywać strony internetowe, aby przeczytać je później lub offline. Za pomocą interfejsu Reading List API możesz pobierać istniejące elementy oraz dodawać i usuwać elementy z listy.

Lista Do przeczytania z liczbą artykułów
Lista czytelnicza zawierająca liczbę artykułów

Pojęcia i zastosowanie

Kolejność produktów

Pozycje na liście Do przeczytania nie są w żadnej gwarantowanej kolejności.

Niepowtarzalność elementu

Elementy są kluczami według adresu URL. Obejmuje to hasz i ciąg zapytania.

Przykłady zastosowań

W sekcjach poniżej przedstawiamy niektóre typowe przypadki użycia interfejsu API listy czytelniczej. Całe przykłady rozszerzeń znajdziesz w sekcji Przykłady rozszerzeń.

Dodaj element

Aby dodać element do listy Do przeczytania, użyj chrome.readingList.addEntry():

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

Wyświetl elementy

Aby wyświetlić elementy z listy Do przeczytania, pobierz je za pomocą metody chrome.readingList.query().

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

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

Oznaczanie elementu jako przeczytanego

Za pomocą chrome.readingList.updateEntry() możesz zaktualizować tytuł, adres URL i stan odczytu. Ten kod oznacza element jako przeczytany:

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

Usuń element

Aby usunąć element, użyj chrome.readingList.removeEntry():

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

Przykłady rozszerzeń

Więcej demonstracji rozszerzeń interfejsu Reading List API znajdziesz w przykładzie interfejsu API listy czytelniczej.

Typy

AddEntryOptions

Właściwości

  • hasBeenRead

    boolean

    Jeśli wpis został przeczytany, wartość to true.

  • title

    string,

    Tytuł wpisu.

  • URL

    string,

    Adres URL wpisu.

QueryInfo

Właściwości

  • hasBeenRead

    wartość logiczna opcjonalna

    Wskazuje, czy mają być wyszukiwane elementy przeczytane (true) czy nieprzeczytane (false).

  • title

    ciąg znaków opcjonalny

    Tytuł do wyszukania.

  • URL

    ciąg znaków opcjonalny

    Adres URL do wyszukania.

ReadingListEntry

Właściwości

  • creationTime

    Liczba

    Godzina utworzenia wpisu. Zarejestrowana w milisekundach od 1 stycznia 1970 r.

  • hasBeenRead

    boolean

    Jeśli wpis został przeczytany, wartość to true.

  • lastUpdateTime

    Liczba

    Data ostatniej aktualizacji wpisu. Ta wartość jest wyrażona w milisekundach od 1 stycznia 1970 r.

  • title

    string,

    Tytuł wpisu.

  • URL

    string,

    Adres URL wpisu.

RemoveOptions

Właściwości

  • URL

    string,

    Adres URL do usunięcia.

UpdateEntryOptions

Właściwości

  • hasBeenRead

    wartość logiczna opcjonalna

    Zaktualizowany stan odczytu. Jeśli nie podasz żadnej wartości, dotychczasowy stan pozostanie niezmieniony.

  • title

    ciąg znaków opcjonalny

    Nowy tytuł. Istniejący kafelek pozostaje bez zmian, jeśli nie podasz żadnej wartości.

  • URL

    string,

    Adres URL, który zostanie zaktualizowany.

Metody

addEntry()

Obietnica 
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

Dodaje wpis do listy Do przeczytania, jeśli nie istnieje.

Parametry

  • Wpis, który chcesz dodać do listy Do przeczytania.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

query()

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

Pobiera wszystkie wpisy pasujące do właściwości QueryInfo. Właściwości, które nie zostaną podane, nie zostaną dopasowane.

Parametry

Akcje powrotne

  • Promise<ReadingListEntry[]>

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

removeEntry()

Obietnica 
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

Usuwa wpis z listy Do przeczytania, jeśli istnieje.

Parametry

  • informacje

    RemoveOptions

    Wpis, który ma zostać usunięty z listy Do przeczytania.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

updateEntry()

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

Aktualizuje pozycję listy Do przeczytania, jeśli istnieje.

Parametry

  • informacje

    UpdateEntryOptions

    Wpis do zaktualizowania.

  • wywołanie zwrotne

    funkcja opcjonalnie

    Parametr callback wygląda tak: 

    ()=>void

Akcje powrotne

  • Promise<void>

    Obietnice są obsługiwane w platformie Manifest V3 i nowszych, ale wywołania zwrotne są dostępne na potrzeby zgodności wstecznej. Nie można użyć obu w tym samym wywołaniu funkcji. Obietnica znika z tym samym typem, który jest przekazywany do wywołania zwrotnego.

Wydarzenia

onEntryAdded

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

Wywoływane, gdy do listy Do przeczytania dodano ReadingListEntry.

Parametry

onEntryRemoved

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

Wywoływane, gdy element ReadingListEntry zostanie usunięty z listy Do przeczytania.

Parametry

onEntryUpdated

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

Wywoływane po zaktualizowaniu elementu ReadingListEntry na liście Do przeczytania.

Parametry