chrome.readingList (original) (raw)

Описание

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

Разрешения

readingList

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

manifest.json:

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

Доступность

В 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

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

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

QueryInfo

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

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

ReadingListEntry

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

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

RemoveOptions

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

• URL-адрес для удаления.

UpdateEntryOptions

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

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

Методы

addEntry()

chrome.readingList.addEntry(
  entry: AddEntryOptions,
): Promise

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

Параметры

• Запись для добавления в список чтения.

Возврат

query()

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

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

Параметры

• Свойства для поиска.

Возврат

• Обещание< ReadingListEntry []>

removeEntry()

chrome.readingList.removeEntry(
  info: RemoveOptions,
): Promise

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

Параметры

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

Возврат

updateEntry()

chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
): Promise

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

Параметры

• Запись для обновления.

Возврат

События

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