chrome.permissions

Description

Concepts et utilisation

Les avertissements concernant les autorisations permettent de décrire les fonctionnalités accordées par une API, mais certains peuvent ne pas être évidents. L'API Permissions permet aux développeurs d'expliquer les avertissements liés aux autorisations et d'introduire progressivement de nouvelles fonctionnalités, ce qui permet aux utilisateurs de découvrir l'extension sans risque. De cette façon, les utilisateurs peuvent spécifier le niveau d'accès qu'ils sont prêts à accorder et les fonctionnalités qu'ils souhaitent activer.

Par exemple, la fonctionnalité de base de l'extension d'autorisation facultative remplace la page "Nouvel onglet". Une fonctionnalité consiste à afficher l'objectif de la journée de l'utilisateur. Cette fonctionnalité ne nécessite que l'autorisation storage. Aucun avertissement n'est affiché. L'extension comporte une fonctionnalité supplémentaire que les utilisateurs peuvent activer en cliquant sur le bouton suivant:

Pour afficher les sites les plus populaires de l'utilisateur, vous devez disposer de l'autorisation topSites, qui comporte l'avertissement suivant.

Implémenter des autorisations facultatives

Étape 1: Déterminez les autorisations requises et facultatives

Une extension peut déclarer des autorisations obligatoires et facultatives. En règle générale, vous devez:

• Utilisez les autorisations requises lorsqu'elles sont nécessaires au fonctionnement de base de votre extension.
• Utilisez des autorisations facultatives lorsqu'elles sont nécessaires pour les fonctionnalités facultatives de votre extension.

Avantages des autorisations obligatoires:

• Moins d'invites:une extension peut inviter l'utilisateur une seule fois à accepter toutes les autorisations.
• Développement simplifié:la présence des autorisations requises est garantie.

Avantages des autorisations facultatives:

• Sécurité améliorée:les extensions s'exécutent avec moins d'autorisations, car les utilisateurs n'activent que les autorisations nécessaires.
• Informations plus utiles pour les utilisateurs:une extension peut expliquer pourquoi elle a besoin d'une autorisation particulière lorsque l'utilisateur active la fonctionnalité concernée.
• Mises à niveau plus faciles:lorsque vous mettez à niveau votre extension, Chrome ne la désactive pas pour vos utilisateurs si la mise à niveau ajoute des autorisations facultatives plutôt que requises.

Étape 2: Déclarez les autorisations facultatives dans le fichier manifeste

Déclarez des autorisations facultatives dans le fichier manifeste d'extension avec la clé optional_permissions, en utilisant le même format que le champ permissions:

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

Si vous souhaitez demander des hôtes que vous ne découvrez qu'au moment de l'exécution, incluez "https://*/*" dans le champ optional_host_permissions de votre extension. Cela vous permet de spécifier n'importe quelle origine dans "Permissions.origins", à condition qu'elle ait un schéma correspondant.

Autorisations qui ne peuvent pas être spécifiées comme facultatives

La plupart des autorisations des extensions Chrome peuvent être spécifiées comme facultatives, avec les exceptions suivantes.

Consultez la section Déclarer des autorisations pour en savoir plus sur les autorisations disponibles et les avertissements associés.

Étape 3: Demandez des autorisations facultatives

Demandez les autorisations d'un geste de l'utilisateur à l'aide de 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 invite l'utilisateur si l'ajout des autorisations entraîne l'affichage de messages d'avertissement différents de ceux que l'utilisateur a déjà vus et acceptés. Par exemple, le code précédent peut entraîner une invite comme celle-ci:

Étape 4: Vérifiez les autorisations actuelles de l'extension

Pour vérifier si votre extension dispose d'une autorisation ou d'un ensemble d'autorisations spécifique, utilisez 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.
  }
});

Étape 5: Supprimez les autorisations

Nous vous conseillons de supprimer les autorisations lorsque vous n'en avez plus besoin. Une fois qu'une autorisation a été supprimée, appeler permissions.request() permet généralement de la rajouter sans afficher d'invite.

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.contains(
  permissions: Permissions,
  callback?: function,
)

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

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

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

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

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