chrome.permissions

Descrição

Conceitos e uso

Os avisos de permissão existem para descrever os recursos concedidos por uma API, mas alguns deles podem não ser óbvios. A API Permissions permite que os desenvolvedores expliquem avisos de permissão e introduzam novos recursos gradualmente, o que oferece aos usuários uma introdução segura à extensão. Assim, os usuários podem especificar o nível de acesso que querem conceder e quais recursos querem ativar.

Por exemplo, a funcionalidade principal da extensão de permissões opcionais substitui a página "Nova guia". Um recurso é mostrar a meta do dia do usuário. Esse recurso só exige a permissão armazenamento, que não inclui um aviso. A extensão tem um recurso extra que pode ser ativado clicando no botão abaixo:

A exibição dos principais sites do usuário requer a permissão topSites, que tem o seguinte aviso.

Implementar permissões opcionais

Etapa 1: decidir quais permissões são obrigatórias e quais são opcionais

Uma extensão pode declarar permissões obrigatórias e opcionais. Em geral, é necessário:

• Use as permissões necessárias quando elas forem necessárias para a funcionalidade básica da extensão.
• Use permissões opcionais quando elas forem necessárias para recursos opcionais na sua extensão.

Vantagens das permissões obrigatórias:

• Menos solicitações:uma extensão pode solicitar que o usuário aceite todas as permissões uma vez.
• Desenvolvimento mais simples:as permissões necessárias estão garantidas.

Vantagens das permissões opcionais:

• Melhor segurança:as extensões são executadas com menos permissões, já que os usuários só ativam as permissões necessárias.
• Melhores informações para os usuários:uma extensão pode explicar por que ela precisa de uma permissão específica quando o usuário ativa o recurso relevante.
• Upgrade mais fácil:quando você faz upgrade da extensão, o Chrome não a desativa para os usuários se o upgrade adicionar permissões opcionais em vez de obrigatórias.

Etapa 2: declarar permissões opcionais no manifesto

Declare permissões opcionais no manifesto da extensão com a chave optional_permissions, usando o mesmo formato do campo permissões:

{
  "name": "My extension",
  ...
  "optional_permissions": ["tabs"],
  "optional_host_permissions": ["https://www.google.com/"],
  ...
}

Se você quiser solicitar hosts que só são descobertos no momento da execução, inclua "https://*/*" no campo optional_host_permissions da extensão. Isso permite especificar qualquer origem em "Permissions.origins", desde que ela tenha um esquema correspondente.

Permissões que não podem ser especificadas como opcionais

A maioria das permissões da extensão do Chrome pode ser especificada como opcional, com as seguintes exceções.

Consulte Declarar permissões para mais informações sobre as permissões disponíveis e os avisos delas.

Etapa 3: solicitar permissões opcionais

Solicite as permissões em um gesto do usuário usando permissions.request():

document.querySelector('#my-button').addEventListener('click', (event) => {
  // Permissions must be requested from inside a user gesture, like a button's
  // click handler.
  chrome.permissions.request({
    permissions: ['tabs'],
    origins: ['https://www.google.com/']
  }, (granted) => {
    // The callback argument will be true if the user granted the permissions.
    if (granted) {
      doSomething();
    } else {
      doSomethingElse();
    }
  });
});

O Chrome solicita ao usuário se a adição das permissões resultar em mensagens de aviso diferentes das que o usuário já viu e aceitou. Por exemplo, o código anterior pode resultar em um comando como este:

Etapa 4: verificar as permissões atuais da extensão

Para verificar se a extensão tem uma permissão ou um conjunto de permissões específico, use permission.contains():

chrome.permissions.contains({
  permissions: ['tabs'],
  origins: ['https://www.google.com/']
}, (result) => {
  if (result) {
    // The extension has the permissions.
  } else {
    // The extension doesn't have the permissions.
  }
});

Etapa 5: remover as permissões

Remova as permissões quando não precisar mais delas. Depois que uma permissão é removida, a chamada de permissions.request() geralmente adiciona a permissão de volta sem solicitar ao usuário.

chrome.permissions.remove({
  permissions: ['tabs'],
  origins: ['https://www.google.com/']
}, (removed) => {
  if (removed) {
    // The permissions have been removed.
  } else {
    // The permissions have not been removed (e.g., you tried to remove
    // required permissions).
  }
});

chrome.permissions.addSiteAccessRequest(
  request: object,
  callback?: function,
)

chrome.permissions.contains(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.getAll(
  callback?: function,
)

chrome.permissions.remove(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.removeSiteAccessRequest(
  request: object,
  callback?: function,
)

chrome.permissions.request(
  permissions: Permissions,
  callback?: function,
)

chrome.permissions.onAdded.addListener(
  callback: function,
)

chrome.permissions.onRemoved.addListener(
  callback: function,
)