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 ou mais recente MV3+

O Chrome apresenta uma Lista de leitura localizada 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 uma série de artigos
Lista de leitura mostrando uma série de artigos

Conceitos e uso

Ordem dos itens

Os itens da Lista de leitura não estão em uma ordem garantida.

Exclusividade do item

Os itens são codificados 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 para a API Reading List. Consulte Amostras de extensões para ver exemplos completos de extensões.

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
});

Itens de tela

Para mostrar itens da lista de leitura, use o método chrome.readingList.query(). .

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ão

Para mais demonstrações de extensões da API Reading List, consulte o exemplo 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

    URL da entrada.

QueryInfo

Propriedades

  • hasBeenRead

    booleano opcional

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

  • título

    string opcional

    Um título a ser pesquisado.

  • url

    string opcional

    Um URL a ser pesquisado.

ReadingListEntry

Propriedades

  • creationTime

    number

    A hora em que a entrada foi criada. Gravado em milissegundos desde 1º de janeiro de 1970.

  • hasBeenRead

    booleano

    Será true se a entrada tiver sido lida.

  • lastUpdateTime

    number

    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

    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()

Promessa 
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

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

Parâmetros

  • A entrada a ser adicionada à lista de leitura.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

query()

Promise 
chrome.readingList.query(
  info: QueryInfo,
  callback?: function,
)

Recupera todas as entradas que correspondem às propriedades QueryInfo. As propriedades não fornecidas não terão correspondência.

Parâmetros

Retorna

  • Promise<ReadingListEntry[]>

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

removeEntry()

Promise 
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

Remove uma entrada da lista de leitura, se houver.

Parâmetros

  • informações

    RemoveOptions

    A entrada a ser removida da lista de leitura.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

updateEntry()

Promise 
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

Atualiza uma entrada da lista de leitura, se houver.

Parâmetros

  • informações

    UpdateEntryOptions

    A entrada a ser atualizada.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

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