chrome.permissions

Descripción

Conceptos y uso

Existen advertencias de permisos para describir las capacidades que otorga una API, pero es posible que algunas de estas advertencias no sean evidentes. La API de Permissions permite a los desarrolladores explicar las advertencias de permisos y presentar funciones nuevas de forma gradual, lo que les brinda a los usuarios una introducción sin riesgos a la extensión. De esta manera, los usuarios pueden especificar qué nivel de acceso están dispuestos a otorgar y qué funciones quieren habilitar.

Por ejemplo, la funcionalidad principal de la extensión de permisos opcionales anula la página Nueva pestaña. Una función muestra el objetivo del día del usuario. Esta función solo requiere el permiso de almacenamiento, que no incluye una advertencia. La extensión tiene una función adicional que los usuarios pueden habilitar haciendo clic en el siguiente botón:

Para mostrar los sitios principales del usuario, se requiere el permiso topSites, que tiene la siguiente advertencia.

Implementa permisos opcionales

Paso 1: Decide qué permisos son obligatorios y cuáles son opcionales

Una extensión puede declarar permisos obligatorios y opcionales. En general, debes hacer lo siguiente:

• Usa los permisos necesarios cuando sean necesarios para la funcionalidad básica de tu extensión.
• Usa permisos opcionales cuando sean necesarios para las funciones opcionales de tu extensión.

Ventajas de los permisos obligatorios:

• Menos indicaciones: Una extensión puede solicitarle al usuario una vez que acepte todos los permisos.
• Desarrollo más simple: Se garantiza que los permisos necesarios estén presentes.

Ventajas de los permisos opcionales:

• Mayor seguridad: Las extensiones se ejecutan con menos permisos, ya que los usuarios solo habilitan los permisos necesarios.
• Mejor información para los usuarios: Una extensión puede explicar por qué necesita un permiso en particular cuando el usuario habilita la función relevante.
• Actualizaciones más fáciles: Cuando actualices tu extensión, Chrome no la inhabilitará para los usuarios si la actualización agrega permisos opcionales en lugar de obligatorios.

Paso 2: Declara permisos opcionales en el manifiesto

Declara permisos opcionales en el manifiesto de la extensión con la clave optional_permissions, con el mismo formato que el campo permissions:

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

Si deseas solicitar hosts que solo descubres en el tiempo de ejecución, incluye "https://*/*" en el campo optional_host_permissions de tu extensión. Esto te permite especificar cualquier origen en "Permissions.origins", siempre y cuando tenga un esquema que coincida.

Permisos que no se pueden especificar como opcionales

La mayoría de los permisos de extensiones de Chrome se pueden especificar como opcionales, con las siguientes excepciones.

Consulta Cómo declarar permisos para obtener más información sobre los permisos disponibles y sus advertencias.

Paso 3: Solicita permisos opcionales

Solicita los permisos desde un gesto del usuario con 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();
    }
  });
});

Chrome le pregunta al usuario si agregar los permisos genera mensajes de advertencia diferentes de los que ya vio y aceptó. Por ejemplo, el código anterior podría generar un mensaje como el siguiente:

Paso 4: Verifica los permisos actuales de la extensión

Para verificar si tu extensión tiene un permiso o un conjunto de permisos específicos, usa 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.
  }
});

Paso 5: Quita los permisos

Debes quitar los permisos cuando ya no los necesites. Después de quitar un permiso, llamar a permissions.request() suele volver a agregarlo sin solicitarle al usuario.

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.addHostAccessRequest(
  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.removeHostAccessRequest(
  request: object,
  callback?: function,
)

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

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

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