chrome.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 のサンプルをご覧ください。

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

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

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

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

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

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

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