chrome.permissions

Description

Concepts et utilisation

Les avertissements d'autorisation permettent de décrire les fonctionnalités accordées par une API, mais certains d'entre eux peuvent ne pas être évidents. L'API Permissions permet aux développeurs d'expliquer les avertissements d'autorisation et de présenter progressivement de nouvelles fonctionnalités, ce qui permet aux utilisateurs de découvrir l'extension sans risque. Les utilisateurs peuvent ainsi 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'autorisations facultatives remplace la page "Nouvel onglet". L'une des fonctionnalités affiche l'objectif de l'utilisateur pour la journée. Cette fonctionnalité ne nécessite que l'autorisation stockage, qui n'inclut pas d'avertissement. L'extension dispose d'une fonctionnalité supplémentaire que les utilisateurs peuvent activer en cliquant sur le bouton suivant:

L'affichage des sites les plus consultés par l'utilisateur nécessite l'autorisation topSites, qui est associée à 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 général, vous devez:

• Utilisez les autorisations requises lorsqu'elles sont nécessaires pour les fonctionnalités de base de votre extension.
• Utilisez des autorisations facultatives lorsque celles-ci sont nécessaires pour les fonctionnalités facultatives de votre extension.

Avantages des autorisations requises:

• Moins d'invites:une extension peut inviter l'utilisateur une seule fois à accepter toutes les autorisations.
• Développement plus simple:les autorisations requises sont garanties.

Avantages des autorisations facultatives:

• Meilleure sécurité:les extensions s'exécutent avec moins d'autorisations, car les utilisateurs n'activent que les autorisations nécessaires.
• Meilleures informations pour les utilisateurs:une extension peut expliquer pourquoi elle a besoin d'une autorisation particulière lorsque l'utilisateur active la fonctionnalité concernée.
• Mise à niveau plus facile: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éclarer les autorisations facultatives dans le fichier manifeste

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

{
  "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. Vous pouvez ainsi spécifier n'importe quelle origine dans "Permissions.origins", à condition qu'elle dispose d'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, à l'exception des suivantes.

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

Étape 3: Demander des autorisations facultatives

Demandez les autorisations à partir d'un geste 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 génère des messages d'avertissement différents de ceux qu'il a déjà vus et acceptés. Par exemple, le code précédent peut générer une invite comme suit:

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

Pour vérifier si votre extension dispose d'une autorisation ou d'un ensemble d'autorisations spécifiques, 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

Vous devez supprimer les autorisations lorsque vous n'en avez plus besoin. Une fois une autorisation supprimée, l'appel de permissions.request() la rétablit généralement sans demander à l'utilisateur.

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