chrome.readingList

설명

chrome.readingList API를 사용하여 읽기 목록의 항목을 읽고 수정합니다.

권한

readingList

읽기 목록 API를 사용하려면 확장 프로그램 매니페스트 파일에 "readingList" 권한을 추가하세요.

manifest.json:

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

가용성

Chrome 120 이상 MV3 이상

Chrome에는 측면 패널에 읽기 목록이 있습니다. 사용자가 웹페이지를 저장하여 나중에 또는 오프라인으로 읽을 수 있습니다. 읽기 목록 API를 사용하여 기존 항목을 가져오고 목록에서 항목을 추가하거나 삭제합니다.

여러 기사가 표시된 읽기 목록
여러 기사가 표시된 읽기 목록

개념 및 사용

상품 주문

읽기 목록의 항목은 보장된 순서로 표시되지 않습니다.

상품 고유성

항목은 URL로 키가 지정됩니다. 여기에는 해시와 쿼리 문자열이 포함됩니다.

사용 사례

다음 섹션에서는 Reading List 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

속성

  • hasBeenRead

    부울

    항목을 읽은 경우 true이 됩니다.

  • 제목

    문자열

    항목의 제목입니다.

  • URL

    문자열

    항목의 URL입니다.

QueryInfo

속성

  • hasBeenRead

    불리언 선택사항

    읽은 항목 (true) 또는 읽지 않은 항목 (false)을 검색할지 여부를 나타냅니다.

  • 제목

    문자열 선택사항

    검색할 콘텐츠 제목입니다.

  • URL

    문자열 선택사항

    검색할 URL입니다.

ReadingListEntry

속성

  • creationTime

    숫자

    항목이 생성된 시간입니다. 1970년 1월 1일 이후 경과된 시간을 밀리초 단위로 기록합니다.

  • hasBeenRead

    부울

    항목을 읽은 경우 true이 됩니다.

  • lastUpdateTime

    숫자

    항목이 마지막으로 업데이트된 시간입니다. 이 값은 1970년 1월 1일 이후 시간을 밀리초 단위로 나타낸 것입니다.

  • 제목

    문자열

    항목의 제목입니다.

  • URL

    문자열

    항목의 URL입니다.

RemoveOptions

속성

  • URL

    문자열

    삭제할 URL입니다.

UpdateEntryOptions

속성

  • hasBeenRead

    불리언 선택사항

    업데이트된 읽음 상태입니다. 값을 제공하지 않으면 기존 상태가 유지됩니다.

  • 제목

    문자열 선택사항

    새 제목입니다. 값을 제공하지 않으면 기존 타일이 유지됩니다.

  • URL

    문자열

    업데이트할 URL입니다.

메서드

addEntry()

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

읽기 목록에 항목이 없는 경우 항목을 추가합니다.

매개변수

반환 값

  • Promise<void>

query()

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

QueryInfo 속성과 일치하는 모든 항목을 가져옵니다. 제공되지 않은 속성은 일치하지 않습니다.

매개변수

  • 정보

    QueryInfo

    검색할 속성입니다.

반환 값

removeEntry()

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

읽기 목록에 항목이 있는 경우 읽기 목록에서 항목을 삭제합니다.

매개변수

  • 정보

    RemoveOptions

    읽기 목록에서 삭제할 항목입니다.

반환 값

  • Promise<void>

updateEntry()

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

읽기 목록 항목이 있는 경우 업데이트합니다.

매개변수

반환 값

  • Promise<void>

이벤트

onEntryAdded

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

ReadingListEntry이 읽기 목록에 추가될 때 트리거됩니다.

매개변수

onEntryRemoved

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

ReadingListEntry이 읽기 목록에서 삭제될 때 트리거됩니다.

매개변수

onEntryUpdated

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

읽기 목록에서 ReadingListEntry가 업데이트될 때 트리거됩니다.

매개변수