chrome.readingList

Описание

Используйте API chrome.readingList для чтения и изменения элементов в списке для чтения .

Разрешения

readingList

Для использования API списков для чтения добавьте разрешение "readingList" в файл манифеста расширения:

manifest.json:

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

Доступность

Chrome 120+ MV3+

В Chrome есть список для чтения, расположенный на боковой панели. Он позволяет пользователям сохранять веб-страницы для последующего чтения или чтения в автономном режиме. Используйте API списка для чтения, чтобы получить доступ к существующим элементам, а также добавлять или удалять элементы из списка.

Список литературы, содержащий ряд статей.
Список литературы, содержащий ряд статей.

Понятия и применение

Заказ товаров

Список литературы не упорядочен каким-либо гарантированным образом.

Уникальность товара

Элементы индексируются по URL-адресу. Это включает в себя хеш и строку запроса.

Варианты использования

В следующих разделах показаны некоторые распространенные варианты использования API списков для чтения. Полные примеры расширений см. в разделе «Примеры расширений ».

Добавить товар

Чтобы добавить элемент в список для чтения, используйте chrome.readingList.addEntry() :

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

Выставочные предметы

Для отображения элементов из списка для чтения используйте метод chrome.readingList.query() для их получения.

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

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

Отметить элемент как прочитанный

Вы можете использовать chrome.readingList.updateEntry() для обновления заголовка, URL-адреса и статуса прочтения. Следующий код помечает элемент как прочитанный:

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

Удалить элемент

Для удаления элемента используйте chrome.readingList.removeEntry() :

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

Образцы расширения

Для получения дополнительных демонстраций расширений API для списков чтения см. пример использования API для списков чтения .

Типы

AddEntryOptions

Характеристики

  • hasBeenRead

    логический

    Это будет true если запись была прочитана.

  • заголовок

    нить

    Заголовок записи.

  • url

    нить

    URL записи.

QueryInfo

Характеристики

  • hasBeenRead

    логический необязательный

    Указывает, следует ли искать прочитанные ( true ) или непрочитанные ( false ) элементы.

  • заголовок

    строка необязательный

    Название для поиска.

  • url

    строка необязательный

    URL-адрес для поиска.

ReadingListEntry

Характеристики

  • creationTime

    число

    Время создания записи. Записано в миллисекундах с 1 января 1970 года.

  • hasBeenRead

    логический

    Это будет true если запись была прочитана.

  • lastUpdateTime

    число

    Последнее обновление записи. Это значение указано в миллисекундах с 1 января 1970 года.

  • заголовок

    нить

    Заголовок записи.

  • url

    нить

    URL записи.

RemoveOptions

Характеристики

  • url

    нить

    URL-адрес, который нужно удалить.

UpdateEntryOptions

Характеристики

  • hasBeenRead

    логический необязательный

    Обновленный статус чтения. Если значение не указано, сохраняется текущий статус.

  • заголовок

    строка необязательный

    Новый заголовок. Если значение не указано, остаётся существующий заголовок.

  • url

    нить

    URL-адрес, который будет обновлен.

Методы

addEntry()

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

Добавляет запись в список литературы, если она отсутствует.

Параметры

Возвраты

  • Обещание<пустота>

    Проблема решается после добавления записи.

query()

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

Извлекает все записи, соответствующие свойствам QueryInfo . Свойства, не указанные в запросе, не будут учитываться.

Параметры

  • информация

    QueryInfo

    Объекты, которые следует искать.

Возвраты

  • Promise< ReadingListEntry []>

    Проблема решается после сопоставления записей.

removeEntry()

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

Удаляет запись из списка литературы, если она существует.

Параметры

  • информация

    RemoveOptions

    Запись, которую следует удалить из списка для чтения.

Возвраты

  • Обещание<пустота>

    Проблема решается после удаления записи.

updateEntry()

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

Обновляет запись в списке литературы, если она существует.

Параметры

  • информация

    UpdateEntryOptions

    Запись, подлежащая обновлению.

Возвраты

  • Обещание<пустота>

    Проблема решается после обновления соответствующих записей.

События

onEntryAdded

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

Срабатывает при добавлении записи из списка для чтения ReadingListEntry ).

Параметры

onEntryRemoved

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

Срабатывает при удалении ReadingListEntry из списка для чтения.

Параметры

onEntryUpdated

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

Срабатывает при обновлении записи в списке для чтения ReadingListEntry ).

Параметры