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 w wersji 120 lub nowszej MV3 lub nowszy

W panelu bocznym Chrome znajduje się lista Do przeczytania. Umożliwia użytkownikom zapisywanie stron internetowych, aby przeczytać je później lub offline. Aby pobierać istniejące elementy i dodawać je do listy lub je z niej usuwać, używaj interfejsu API listy czytelniczej.

Lista czytelnicza zawierająca pewną liczbę artykułów
Lista czytelnicza zawierająca pewną liczbę artykułów

Pojęcia i wykorzystanie

Kolejność produktów

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

Unikalność produktu

Elementy mają przypisany klucz adresu URL. Dotyczy to również ciągu znaków haszowanych i zapytania.

Przypadki użycia

W sekcjach poniżej opisujemy kilka typowych przypadków użycia interfejsu Reading List API. Pełne przykłady rozszerzeń znajdziesz w sekcji Przykłady rozszerzeń.

Dodaj element

Aby dodać element do listy Do przeczytania, użyj polecenia 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

Korzystając z chrome.readingList.updateEntry(), możesz zaktualizować tytuł, adres URL i stan czytania. Ten kod oznacza element jako przeczytany:

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

Usuwanie elementów

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

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

Przykłady rozszerzeń

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

Typy

AddEntryOptions

Właściwości

  • hasBeenRead

    wartość logiczna

    Jeśli wpis został odczytany, ma wartość true.

  • tytuł

    ciąg znaków

    Tytuł wpisu.

  • URL

    ciąg znaków

    Adres URL wpisu.

QueryInfo

Właściwości

  • hasBeenRead

    logiczna opcjonalna

    Wskazuje, czy szukać przeczytanych (true) czy nieprzeczytanych (false) elementów.

  • tytuł

    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

    Czas utworzenia wpisu. Zapisano w milisekundach od 1 stycznia 1970 roku.

  • hasBeenRead

    wartość logiczna

    Jeśli wpis został odczytany, ma wartość true.

  • lastUpdateTime

    liczba

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

  • tytuł

    ciąg znaków

    Tytuł wpisu.

  • URL

    ciąg znaków

    Adres URL wpisu.

RemoveOptions

Właściwości

  • URL

    ciąg znaków

    Adres URL do usunięcia.

UpdateEntryOptions

Właściwości

  • hasBeenRead

    logiczna opcjonalna

    Zaktualizowany stan czytania. Jeśli nie podasz wartości, zachowa się dotychczasowy stan.

  • tytuł

    ciąg znaków opcjonalny

    Nowy tytuł. Jeśli nie podasz wartości, pozostanie dotychczasowa płytka.

  • URL

    ciąg znaków

    Adres URL, który zostanie zaktualizowany.

Metody

addEntry()

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

Jeśli wpis nie istnieje, dodaje go do listy Do przeczytania.

Parametry

  • Wpis, który ma zostać dodany do listy Do przeczytania.

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback wygląda tak: 

    () => void
    .

Zwroty

  • Promise<void>

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

query()

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

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

Parametry

Zwroty

  • Promise<ReadingListEntry[]>

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

removeEntry()

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

Usuwa pozycję z listy Do przeczytania, jeśli istnieje.

Parametry

  • informacje

    RemoveOptions

    Wpis do usunięcia z listy Do przeczytania.

  • wywołanie zwrotne

    function opcjonalny

    Parametr callback wygląda tak: 

    () => void
    .

Zwroty

  • Promise<void>

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

updateEntry()

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

Aktualizuje pozycję na liście Do przeczytania, jeśli istnieje.

Parametry

  • informacje

    UpdateEntryOptions

    Wpis do zaktualizowania.

  • wywołanie zwrotne

    funkcja optional

    Parametr callback ma postać:

    () => void

Zwroty

  • Promise<void>

    Obietnice są obsługiwane w Manifest V3 i nowszych, ale wywołania zwrotne są podane w przypadku zgodność wsteczną. Nie można użyć obu w tym samym wywołaniu funkcji. Polecenie promowana jest realizowane z tym samym typem, który jest przekazywany do wywołania zwrotnego.

Wydarzenia

onEntryAdded

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

Wywoływane po dodaniu do listy Do przeczytania element ReadingListEntry.

Parametry

onEntryRemoved

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

Aktywowane, gdy element ReadingListEntry zostanie usunięty z listy Do przeczytania.

Parametry

onEntryUpdated

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

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

Parametry