chrome.browsingData

Descrição

Use a API chrome.browsingData para remover dados de navegação do perfil local de um usuário.

Permissões

browsingData

Manifesto

É preciso declarar a permissão "browsingData" no manifesto de extensões para usar essa API.

{
  "name": "My extension",
  ...
  "permissions": [
    "browsingData",
  ],
  ...
}

Uso

O caso de uso mais simples dessa API é um mecanismo baseado em tempo para limpar os dados de navegação de um usuário. Seu código precisa fornecer um carimbo de data/hora que indique a data histórica após a qual os dados de navegação do usuário serão removidos. Esse carimbo de data/hora é formatado como o número de milissegundos desde a época Unix (que pode ser recuperada de um objeto Date JavaScript por meio do método getTime).

Por exemplo, para limpar todos os dados de navegação de um usuário da última semana, escreva o código da seguinte maneira:

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.remove({
  "since": oneWeekAgo
}, {
  "appcache": true,
  "cache": true,
  "cacheStorage": true,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "passwords": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

O método chrome.browsingData.remove permite remover vários tipos de dados de navegação com uma única chamada e é muito mais rápido do que chamar vários métodos mais específicos. No entanto, se você quiser limpar apenas um tipo específico de dados de navegação (cookies, por exemplo), os métodos mais granulares oferecem uma alternativa legível a uma chamada preenchida com JSON.

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.removeCookies({
  "since": oneWeekAgo
}, callback);

Se o usuário estiver sincronizando os dados, o chrome.browsingData.remove poderá recriar automaticamente o cookie da conta de sincronização depois de limpá-lo. Isso garante que a sincronização continue funcionando, para que os dados possam ser excluídos do servidor. No entanto, o chrome.browsingData.removeCookies mais específico pode ser usado para limpar o cookie da conta de sincronização. Nesse caso, a sincronização será pausada.

Origens específicas

Para remover dados de uma origem específica ou excluir um conjunto de origens da exclusão, use os parâmetros RemovalOptions.origins e RemovalOptions.excludeOrigins. Elas só podem ser aplicadas a cookies, cache e armazenamento (CacheStorage, FileSystems, IndexedDB, LocalStorage, ServiceWorkers e WebSQL).

chrome.browsingData.remove({
  "origins": ["https://www.example.com"]
}, {
  "cacheStorage": true,
  "cookies": true,
  "fileSystems": true,
  "indexedDB": true,
  "localStorage": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

Tipos de origem

Adicionar uma propriedade originTypes ao objeto de opções da API permite especificar quais tipos de origens precisam ser afetados. Atualmente, as origens estão divididas em três categorias:

  • unprotectedWeb abrange o caso geral de sites que os usuários acessam sem realizar nenhuma ação especial. Se você não especificar um originTypes, o padrão da API será remover dados de origens da Web não protegidas.
  • protectedWeb abrange as origens da Web que foram instaladas como aplicativos hospedados. A instalação do Angry Birds, por exemplo, protege a origem https://chrome.angrybirds.com e a remove da categoria unprotectedWeb. Tenha cuidado ao acionar a exclusão de dados dessas origens: verifique se os usuários sabem o que estão recebendo, porque isso vai remover de modo irrevogável os dados do jogo deles. Ninguém quer derrubar pequenos porcos com mais frequência do que o necessário.
  • extension abrange origens no esquema chrome-extensions:. A remoção de dados de extensão é algo com que você precisa ter muito cuidado.

Podemos ajustar o exemplo anterior para remover apenas dados de sites protegidos da seguinte forma:

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.remove({
  "since": oneWeekAgo,
  "originTypes": {
    "protectedWeb": true
  }
}, {
  "appcache": true,
  "cache": true,
  "cacheStorage": true,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "passwords": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

Exemplos

Para testar essa API, instale o exemplo da API BrowsingData (em inglês) a partir do repositório chrome-extension-samples.

Tipos

DataTypeSet

Um conjunto de tipos de dados. Os tipos de dados ausentes são interpretados como false.

Propriedades

  • cache de app

    booleano opcional

    Caches de apps de sites.

  • cache

    booleano opcional

    O cache do navegador.

  • cacheStorage

    booleano opcional

    Chrome 72 ou versões mais recentes

    Armazenamento em cache

  • cookies

    booleano opcional

    Os cookies do navegador.

  • de músicas

    booleano opcional

    A lista de downloads do navegador.

  • fileSystems

    booleano opcional

    Sistemas de arquivos de sites.

  • formData

    booleano opcional

    Os dados de formulário armazenados do navegador.

  • histórico

    booleano opcional

    O histórico do navegador.

  • indexedDB

    booleano opcional

    Dados do IndexedDB dos sites.

  • localStorage

    booleano opcional

    Dados de armazenamento local de sites.

  • senhas

    booleano opcional

    Senhas armazenadas.

  • pluginData

    booleano opcional

    Uso suspenso desde o Chrome 88

    O suporte para Flash foi removido. Esse tipo de dado será ignorado.

    Dados dos plug-ins.

  • serverBoundCertificates

    booleano opcional

    Uso descontinuado desde o Chrome 76

    O suporte para certificados vinculados ao servidor foi removido. Esse tipo de dado será ignorado.

    Certificados vinculados ao servidor.

  • serviceWorkers

    booleano opcional

    Service Workers

  • webSQL

    booleano opcional

    Dados do WebSQL de sites.

RemovalOptions

Opções que determinam exatamente quais dados serão removidos.

Propriedades

  • excludeOrigins

    string[] opcional

    Chrome 74 ou versão mais recente

    Quando presentes, os dados para origens nesta lista são excluídos da exclusão. Não pode ser usado com origins. Compatível apenas com cookies, armazenamento e cache. Os cookies são excluídos de todo o domínio registrável.

  • originTypes

    objeto opcional

    Um objeto com propriedades que especificam quais tipos de origem devem ser apagados. Se esse objeto não for especificado, o padrão será limpar apenas origens "desprotegidas". Certifique-se de que você realmente deseja remover os dados de aplicativo antes de adicionar "protegidoWeb" ou "extensões".

    • extension

      booleano opcional

      Extensões e aplicativos empacotados que um usuário instalou (tenha _muito_ cuidado!).

    • protectedWeb

      booleano opcional

      Sites que foram instalados como aplicativos hospedados (tome cuidado!).

    • unprotectedWeb

      booleano opcional

      Sites normais.

  • origens

    [string, ...string[]] optional

    Chrome 74 ou versão mais recente

    Quando presente, somente os dados para origens nesta lista são excluídos. Compatível apenas com cookies, armazenamento e cache. Os cookies são apagados para todo o domínio registrável.

  • desde que

    número opcional

    Remova os dados acumulados nessa data ou depois dela, representados em milissegundos desde a época (acessível pelo método getTime do objeto JavaScript Date). Se ausente, o padrão é 0 (o que remove todos os dados de navegação).

Métodos

remove()

Promessa 
chrome.browsingData.remove(
  options: RemovalOptions,
  dataToRemove: DataTypeSet,
  callback?: function,
)

Limpa vários tipos de dados de navegação armazenados no perfil de um usuário.

Parâmetros

  • do modelo.

    RemovalOptions

  • dataToRemove

    DataTypeSet

    O conjunto de tipos de dados a serem removidos.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeAppcache()

Promessa 
chrome.browsingData.removeAppcache(
  options: RemovalOptions,
  callback?: function,
)

Limpa os dados do cache do app de sites.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeCache()

Promessa 
chrome.browsingData.removeCache(
  options: RemovalOptions,
  callback?: function,
)

Limpa o cache do navegador.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeCacheStorage()

Promessa Chrome 72+ 
chrome.browsingData.removeCacheStorage(
  options: RemovalOptions,
  callback?: function,
)

Limpa os dados de armazenamento em cache dos sites.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeCookies()

Promessa 
chrome.browsingData.removeCookies(
  options: RemovalOptions,
  callback?: function,
)

Limpa os cookies do navegador e os certificados vinculados ao servidor modificados dentro de um período específico.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeDownloads()

Promessa 
chrome.browsingData.removeDownloads(
  options: RemovalOptions,
  callback?: function,
)

Limpa a lista de arquivos transferidos por download do navegador (não os arquivos transferidos por download).

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeFileSystems()

Promessa 
chrome.browsingData.removeFileSystems(
  options: RemovalOptions,
  callback?: function,
)

Limpa os dados do sistema de arquivos dos sites.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeFormData()

Promessa 
chrome.browsingData.removeFormData(
  options: RemovalOptions,
  callback?: function,
)

Limpa os dados de formulário armazenados do navegador (preenchimento automático).

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeHistory()

Promessa 
chrome.browsingData.removeHistory(
  options: RemovalOptions,
  callback?: function,
)

Limpa o histórico do navegador.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeIndexedDB()

Promessa 
chrome.browsingData.removeIndexedDB(
  options: RemovalOptions,
  callback?: function,
)

Limpa os dados do IndexedDB dos sites.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeLocalStorage()

Promessa 
chrome.browsingData.removeLocalStorage(
  options: RemovalOptions,
  callback?: function,
)

Limpa os dados de armazenamento local dos sites.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removePasswords()

Promessa 
chrome.browsingData.removePasswords(
  options: RemovalOptions,
  callback?: function,
)

Limpa as senhas armazenadas do navegador.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removePluginData()

Promessa Descontinuada desde o Chrome 88
chrome.browsingData.removePluginData(
  options: RemovalOptions,
  callback?: function,
)

O suporte para Flash foi removido. Essa função não tem efeito.

Limpa os dados dos plug-ins.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeServiceWorkers()

Promessa Chrome 72+ 
chrome.browsingData.removeServiceWorkers(
  options: RemovalOptions,
  callback?: function,
)

Limpa os service workers dos sites.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeWebSQL()

Promessa 
chrome.browsingData.removeWebSQL(
  options: RemovalOptions,
  callback?: function,
)

Limpa os dados do WebSQL dos sites.

Parâmetros

  • do modelo.

    RemovalOptions

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promise<void>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

settings()

Promessa 
chrome.browsingData.settings(
  callback?: function,
)

Informa quais tipos de dados estão selecionados na interface de configurações de "Limpar dados de navegação". Observação: alguns dos tipos de dados incluídos nessa API não estão disponíveis na interface de configurações, e algumas configurações de interface controlam mais de um tipo de dados listado aqui.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (result: object) => void

    • resultado

      objeto

      • dataRemovalPermitted

        DataTypeSet

        Todos os tipos vão estar presentes no resultado, com valores true se tiverem permissão para serem removidos (por exemplo, pela política da empresa) e false se não puderem.

      • dataToRemove

        DataTypeSet

        Todos os tipos vão estar presentes no resultado, com valores de true se forem selecionados para remoção e permitirem a remoção deles. Caso contrário, será false.

      • do modelo.

        RemovalOptions

Retorna

  • Promise<object>

    Chrome 96 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.