chrome.readingList

Opis

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

Uprawnienia

readingList

Aby korzystać z interfejsu Reading List API, dodaj uprawnienie "readingList" w pliku manifestu rozszerzenia:

manifest.json:

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

Dostępność

Chrome 120+ MV3+

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

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

Pojęcia i zastosowanie

Kolejność produktów

Elementy na liście Do przeczytania nie są ułożone w gwarantowanej kolejności.

Unikalność produktu

Elementy są kluczowane według adresu URL. Obejmuje to hash i ciąg zapytania.

Przypadki użycia

W kolejnych sekcjach przedstawiamy 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 chrome.readingList.addEntry():

chrome.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 lektur, użyj 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

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

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

Usuwanie elementów

Aby usunąć element, użyj ikony 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 Reading List API.

Typy

AddEntryOptions

Właściwości

  • hasBeenRead

    Wartość logiczna

    Będzie to true, jeśli wpis został odczytany.

  • tytuł

    ciąg znaków

    Tytuł wpisu.

  • URL

    ciąg znaków

    Adres URL wpisu.

QueryInfo

Właściwości

  • hasBeenRead

    wartość logiczna opcjonalna

    Określa, czy wyszukiwać przeczytane (true) czy nieprzeczytane (false) elementy.

  • 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. Zapisywany w milisekundach od 1 stycznia 1970 r.

  • hasBeenRead

    Wartość logiczna

    Będzie to true, jeśli wpis został odczytany.

  • lastUpdateTime

    liczba

    Ostatnia aktualizacja wpisu. Ta wartość jest podawana w milisekundach od 1 stycznia 1970 r.

  • 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

    wartość logiczna opcjonalna

    Zaktualizowany stan odczytu. Jeśli nie podasz wartości, dotychczasowy stan pozostanie bez zmian.

  • tytuł

    ciąg znaków opcjonalny

    Nowy tytuł. Jeśli nie podasz wartości, istniejący kafelek pozostanie bez zmian.

  • URL

    ciąg znaków

    Adres URL, który zostanie zaktualizowany.

Metody

addEntry()

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

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

Parametry

Zwroty

  • Promise<void>

    Zostanie rozwiązany po dodaniu wpisu.

query()

chrome.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 są podane, nie zostaną dopasowane.

Parametry

  • informacje

    QueryInfo

    Właściwości do wyszukania.

Zwroty

removeEntry()

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

Usuwa wpis z listy Do przeczytania, jeśli na niej jest.

Parametry

  • informacje

    RemoveOptions

    Wpis do usunięcia z listy Do przeczytania.

Zwroty

  • Promise<void>

    Problem zostanie rozwiązany po usunięciu wpisu.

updateEntry()

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

Aktualizuje wpis na liście lektur, jeśli istnieje.

Parametry

Zwroty

  • Promise<void>

    Rozwiązuje się po zaktualizowaniu pasujących wpisów.

Wydarzenia

onEntryAdded

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

Wywoływane, gdy do listy Do przeczytania zostanie dodana ReadingListEntry.

Parametry

onEntryRemoved

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

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

Parametry

onEntryUpdated

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

Wywoływane, gdy ReadingListEntry jest aktualizowany na liście lektur.

Parametry