chrome.readingList

Descrição

Use a API chrome.readingList para ler e modificar os itens na Lista de leitura.

Permissões

readingList

Para usar a API Reading List, adicione a permissão "readingList" ao arquivo manifesto da extensão:

manifest.json:

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

Disponibilidade

Chrome 120+ MV3+

O Chrome tem uma Lista de leitura no painel lateral. Ele permite que os usuários salvem páginas da Web para ler mais tarde ou quando estiverem off-line. Use a API Reading List para recuperar itens e adicionar ou remover itens da lista.

Lista de leitura mostrando vários artigos
Lista de leitura mostrando vários artigos

Conceitos e uso

Ordem dos itens

Os itens na lista de leitura não estão em nenhuma ordem garantida.

Exclusividade do item

Os itens são identificados por URL. Isso inclui o hash e a string de consulta.

Casos de uso

As seções a seguir demonstram alguns casos de uso comuns da API Reading List. Consulte Exemplos de extensões para ver exemplos completos.

Adicionar um item

Para adicionar um item à Lista de leitura, use chrome.readingList.addEntry():

chrome.readingList.addEntry({
  title: "New to the web platform in September | web.dev",
  url: "https://developer.chrome.com/",
  hasBeenRead: false
});

Mostrar itens

Para mostrar itens da lista de leitura, use o método chrome.readingList.query() para recuperá-los. método.

const items = await chrome.readingList.query({});

for (const item of items) {
  // Do something do display the item
}

Marcar um item como lido

Use chrome.readingList.updateEntry() para atualizar o título, o URL e o status de leitura. O código a seguir marca um item como lido:

chrome.readingList.updateEntry({
  url: "https://developer.chrome.com/",
  hasBeenRead: true
});

Remover um item

Para remover um item, use chrome.readingList.removeEntry():

chrome.readingList.removeEntry({
  url: "https://developer.chrome.com/"
});

Exemplos de extensões

Para mais demonstrações de extensões da API Reading List, consulte a amostra da API Reading List.

Tipos

AddEntryOptions

Propriedades

  • hasBeenRead

    booleano

    Será true se a entrada tiver sido lida.

  • título

    string

    O título da entrada.

  • url

    string

    O URL da entrada.

QueryInfo

Propriedades

  • hasBeenRead

    booleano opcional

    Indica se é para pesquisar itens lidos (true) ou não lidos (false).

  • título

    string opcional

    Um título para pesquisar.

  • url

    string opcional

    Um URL para pesquisar.

ReadingListEntry

Propriedades

  • creationTime

    número

    O horário em que a entrada foi criada. Registrado em milissegundos desde 1º de janeiro de 1970.

  • hasBeenRead

    booleano

    Será true se a entrada tiver sido lida.

  • lastUpdateTime

    número

    A última vez que a entrada foi atualizada. Esse valor está em milissegundos desde 1º de janeiro de 1970.

  • título

    string

    O título da entrada.

  • url

    string

    O URL da entrada.

RemoveOptions

Propriedades

  • url

    string

    O URL a ser removido.

UpdateEntryOptions

Propriedades

  • hasBeenRead

    booleano opcional

    O status de leitura atualizado. O status atual permanece se um valor não for fornecido.

  • título

    string opcional

    O novo título. O bloco atual permanece se um valor não for fornecido.

  • url

    string

    O URL que será atualizado.

Métodos

addEntry()

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

Adiciona uma entrada à lista de leitura se ela não existir.

Parâmetros

Retorna

  • Promise<void>

query()

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

Recupera todas as entradas que correspondem às propriedades QueryInfo. As propriedades não fornecidas não serão correspondidas.

Parâmetros

  • informações

    QueryInfo

    As propriedades a serem pesquisadas.

Retorna

removeEntry()

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

Remove uma entrada da lista de leitura, se ela existir.

Parâmetros

  • informações

    RemoveOptions

    A entrada a ser removida da lista de leitura.

Retorna

  • Promise<void>

updateEntry()

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

Atualiza uma entrada da lista de leitura, se ela existir.

Parâmetros

Retorna

  • Promise<void>

Eventos

onEntryAdded

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

Acionado quando um ReadingListEntry é adicionado à lista de leitura.

Parâmetros

onEntryRemoved

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

Acionado quando um ReadingListEntry é removido da lista de leitura.

Parâmetros

onEntryUpdated

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

Acionado quando um ReadingListEntry é atualizado na lista de leitura.

Parâmetros