chrome.readingList

설명

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

권한

readingList

Reading List API를 사용하려면 확장 프로그램 manifest 파일에 "readingList" 권한을 추가합니다.

manifest.json:

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

지원 대상

Chrome 120 이상 MV3 이상

Chrome에는 측면 패널에 읽기 목록이 있습니다. 사용자는 웹페이지를 저장하여 나중에 또는 오프라인일 때 읽을 수 있습니다. Reading List 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

    boolean

    항목을 읽은 경우 true입니다.

  • title

    string

    항목의 제목입니다.

  • url

    string

    항목의 URL입니다.

QueryInfo

속성

  • hasBeenRead

    부울 선택사항

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

  • title

    문자열 선택사항

    검색할 제목입니다.

  • url

    문자열 선택사항

    검색할 URL입니다.

ReadingListEntry

속성

  • creationTime

    숫자

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

  • hasBeenRead

    boolean

    항목을 읽은 경우 true입니다.

  • lastUpdateTime

    숫자

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

  • title

    string

    항목의 제목입니다.

  • url

    string

    항목의 URL입니다.

RemoveOptions

속성

  • url

    string

    삭제할 URL입니다.

UpdateEntryOptions

속성

  • hasBeenRead

    부울 선택사항

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

  • title

    문자열 선택사항

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

  • url

    string

    업데이트할 URL입니다.

방법

addEntry()

프로미스 
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

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

매개변수

  • 읽기 목록에 추가할 항목입니다.

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    ()=>void

반환 값

  • Promise<void>

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

query()

프로미스 
chrome.readingList.query(
  info: QueryInfo,
  callback?: function,
)

QueryInfo 속성과 일치하는 모든 항목을 검색합니다. 제공되지 않은 숙박 시설은 일치되지 않습니다.

매개변수

반환 값

  • Promise<ReadingListEntry[]>

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

removeEntry()

프로미스 
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

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

매개변수

  • 정보

    RemoveOptions

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

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    ()=>void

반환 값

  • Promise<void>

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

updateEntry()

프로미스 
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

읽기 목록 항목이 있으면 업데이트합니다.

매개변수

  • 업데이트할 항목입니다.

  • 콜백

    함수 선택사항

    callback 매개변수는 다음과 같습니다. 

    ()=>void

반환 값

  • Promise<void>

    프로미스는 Manifest V3 이상에서 지원되지만 콜백은 이전 버전과의 호환성을 위해 제공됩니다. 동일한 함수 호출에 둘 다 사용할 수는 없습니다. 프로미스는 콜백에 전달된 것과 동일한 유형으로 확인됩니다.

이벤트

onEntryAdded

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

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

매개변수

onEntryRemoved

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

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

매개변수

onEntryUpdated

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

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

매개변수