Эта страница переведена с помощью Cloud Translation API.

chrome.readingList

Описание

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

Разрешения

readingList

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

манифест.json:

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

Доступность

Хром 120+ МВ3+

В 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/"
});

Примеры расширений

Дополнительные демонстрации расширений Reading List API см. в примере Reading List API .

Типы

AddEntryOptions

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

было прочитано
логическое значение
Будет true , если запись была прочитана.
заголовок
нить
Название записи.
URL
нить
URL-адрес записи.

QueryInfo

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

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

ReadingListEntry

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

время создания
число
Время создания записи. Записано в миллисекундах с 1 января 1970 года.
было прочитано
логическое значение
Будет true , если запись была прочитана.
последнее обновление времени
число
Время последнего обновления записи. Это значение указывается в миллисекундах с 1 января 1970 года.
заголовок
нить
Название записи.
URL
нить
URL-адрес записи.

RemoveOptions

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

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

UpdateEntryOptions

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

было прочитано
логическое значение необязательно
Обновленный статус чтения. Существующий статус сохраняется, если значение не указано.
заголовок
строка необязательна
Новое название. Существующая плитка остается, если значение не указано.
URL
нить
URL-адрес, который будет обновлен.

Методы

addEntry()

Обещать

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

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

Параметры

вход
АддEntryOptions
Запись для добавления в список чтения.
перезвонить
функция необязательна
Параметр callback выглядит так:
```
() => void
```

Возврат

Обещание<void>
Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

query()

Обещать

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

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

Параметры

информация
ЗапросИнформация
Свойства для поиска.
перезвонить
функция необязательна
Параметр callback выглядит так:
```
(entries: ReadingListEntry[]) => void
```
- записи
  ЧтениеСпискаЭнтри []

Возврат

Обещание < ReadingListEntry []>
Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

removeEntry()

Обещать

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

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

Параметры

информация
Удалить параметры
Запись, которую нужно удалить из списка чтения.
перезвонить
функция необязательна
Параметр callback выглядит так:
```
() => void
```

Возврат

Обещание<void>
Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

updateEntry()

Обещать

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

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

Параметры

информация
ОбновлениеEntryOptions
Запись для обновления.
перезвонить
функция необязательна
Параметр callback выглядит так:
```
() => void
```

Возврат

Обещание<void>
Промисы поддерживаются в Манифесте V3 и более поздних версиях, но обратные вызовы предусмотрены для обратной совместимости. Вы не можете использовать оба при одном вызове функции. Промис разрешается с тем же типом, который передается в обратный вызов.

События

onEntryAdded

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

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

Параметры

перезвонить
функция
Параметр callback выглядит так:
```
(entry: ReadingListEntry) => void
```
- вход
  ЧтениеСписокЗапись

onEntryRemoved

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

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

Параметры

перезвонить
функция
Параметр callback выглядит так:
```
(entry: ReadingListEntry) => void
```
- вход
  ЧтениеСписокЗапись

onEntryUpdated

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

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

Параметры

перезвонить
функция
Параметр callback выглядит так:
```
(entry: ReadingListEntry) => void
```
- вход
  ЧтениеСписокЗапись