browser.readingList

Opis

Użyj interfejsu API chrome.readingList, aby odczytywać i modyfikować elementy na liście Do przeczytania.

Uprawnienia

readingList

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

manifest.json:

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

Dostępność

Chrome 120 lub nowsza browser.* od Chrome 148 MV3 lub nowsza

Chrome ma listę Do przeczytania, która znajduje się w panelu bocznym. Umożliwia użytkownikom zapisywanie stron internetowych, aby mogli je przeczytać później lub offline. Użyj interfejsu Reading List API, aby pobrać istniejące elementy i dodać lub usunąć elementy z listy.

Lista do przeczytania z liczbą artykułów
Lista Do przeczytania z kilkoma artykułami

Pojęcia i użycie

Kolejność elementów

Elementy na liście Do przeczytania nie są uporządkowane w żaden gwarantowany sposób.

Unikalność produktu

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

Przypadki użycia

W sekcjach poniżej przedstawiamy kilka typowych przypadków użycia interfejsu Reading List API. Przykłady pełnych rozszerzeń znajdziesz w sekcji Przykłady rozszerzeń.

Dodaj element

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

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

Wyświetlanie elementów

Aby wyświetlić elementy z listy Do przeczytania, użyj metody browser.readingList.query().

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

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

Oznaczanie elementu jako przeczytanego

Możesz użyć browser.readingList.updateEntry(), aby zaktualizować tytuł, adres URL i stan odczytu. Poniższy kod oznacza element jako przeczytany:

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

Usuwanie elementów

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

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

Przykłady rozszerzeń

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

Typy

AddEntryOptions

Właściwości

  • hasBeenRead

    wartość logiczna

    Jeśli wpis został odczytany, będzie to true.

  • tytuł

    tekst

    Tytuł wpisu.

  • URL

    tekst

    Adres URL wpisu.

QueryInfo

Właściwości

  • hasBeenRead

    boolean opcjonalne

    Wskazuje, czy wyszukiwać elementy przeczytane (true) czy nieprzeczytane (false).

  • tytuł

    ciąg znaków opcjonalny

    Tytuł, który chcesz wyszukać.

  • URL

    ciąg znaków opcjonalny

    Adres URL do wyszukania.

ReadingListEntry

Właściwości

  • creationTime

    liczba

    Czas utworzenia wpisu. Zapisywany w milisekundach od 1 stycznia 1970 r.

  • hasBeenRead

    wartość logiczna

    Jeśli wpis został odczytany, będzie to true.

  • lastUpdateTime

    liczba

    Czas ostatniej aktualizacji wpisu. Ta wartość jest podawana w milisekundach od 1 stycznia 1970 r.

  • tytuł

    tekst

    Tytuł wpisu.

  • URL

    tekst

    Adres URL wpisu.

RemoveOptions

Właściwości

  • URL

    tekst

    Adres URL do usunięcia.

UpdateEntryOptions

Właściwości

  • hasBeenRead

    boolean opcjonalne

    Zaktualizowany stan przeczytania. Jeśli nie podasz wartości, zachowany zostanie dotychczasowy stan.

  • tytuł

    ciąg znaków opcjonalny

    Nowy tytuł. Jeśli nie podasz wartości, zachowany zostanie dotychczasowy kafelek.

  • URL

    tekst

    Adres URL, który zostanie zaktualizowany.

Metody

addEntry()

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

Dodaje wpis do listy Do przeczytania, jeśli jeszcze go tam nie ma.

Parametry

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

Zwroty

  • thought Promise<void>

    Rozwiązuje problem po dodaniu wpisu.

query()

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

Pobiera wszystkie wpisy, które pasują do właściwości QueryInfo. Właściwości, które nie zostały podane, nie będą dopasowywane.

Parametry

  • informacje

    QueryInfo

    Właściwości, które chcesz wyszukać.

Zwroty

removeEntry()

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

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

Parametry

  • informacje

    RemoveOptions

    Wpis do usunięcia z listy Do przeczytania.

Zwroty

  • thought Promise<void>

    Rozwiązuje się po usunięciu wpisu.

updateEntry()

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

Aktualizuje wpis na liście Do przeczytania, jeśli istnieje.

Parametry

Zwroty

  • thought Promise<void>

    Rozwiązuje problem po zaktualizowaniu pasujących wpisów.

Wydarzenia

onEntryAdded

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

Uruchamiane, gdy ReadingListEntry zostanie dodany do listy Do przeczytania.

Parametry

onEntryRemoved

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

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

Parametry

onEntryUpdated

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

Uruchamiane, gdy ReadingListEntry zostanie zaktualizowany na liście Do przeczytania.

Parametry