chrome.permissions

Beschrijving

Overzicht

Toestemmingswaarschuwingen beschrijven de mogelijkheden die een API biedt, maar sommige van deze waarschuwingen zijn mogelijk niet voor de hand liggend. Met de Permissions API kunnen ontwikkelaars toestemmingswaarschuwingen uitleggen en geleidelijk nieuwe functies introduceren, waardoor gebruikers zonder risico kennis kunnen maken met de extensie. Zo kunnen gebruikers aangeven hoeveel toegang ze willen verlenen en welke functies ze willen inschakelen.

De kernfunctionaliteit van de optionele machtigingenextensie is bijvoorbeeld het overschrijven van de nieuwe tabbladpagina. Eén functie is het weergeven van het doel van de gebruiker voor die dag. Deze functie vereist alleen de opslagmachtiging , die geen waarschuwing bevat. De extensie heeft een extra functie die gebruikers kunnen inschakelen door op de volgende knop te klikken:

Om de topsites van de gebruiker weer te geven, is de topSites- machtiging vereist. Deze bevat de volgende waarschuwing.

Optionele machtigingen implementeren

Stap 1: Bepaal welke machtigingen vereist zijn en welke optioneel zijn

Een extensie kan zowel vereiste als optionele rechten declareren. Over het algemeen geldt het volgende:

• Gebruik de vereiste machtigingen wanneer deze nodig zijn voor de basisfunctionaliteit van uw extensie.
• Gebruik optionele machtigingen wanneer deze nodig zijn voor optionele functies in uw extensie.

Voordelen van vereiste machtigingen:

• Minder vragen: een extensie kan de gebruiker één keer vragen om alle rechten te accepteren.
• Eenvoudigere ontwikkeling: De vereiste rechten zijn gegarandeerd aanwezig.

Voordelen van optionele machtigingen:

• Betere beveiliging: Extensies worden uitgevoerd met minder machtigingen, omdat gebruikers alleen de machtigingen inschakelen die nodig zijn.
• Betere informatie voor gebruikers: een extensie kan uitleggen waarom er een bepaalde toestemming nodig is wanneer de gebruiker de relevante functie inschakelt.
• Eenvoudigere upgrades: Wanneer u uw extensie upgradet, schakelt Chrome deze niet uit voor uw gebruikers als de upgrade optionele rechten toevoegt in plaats van vereiste rechten.

Stap 2: Declareer optionele machtigingen in het manifest

Declareer optionele machtigingen in uw extensiemanifest met de sleutel optional_permissions , waarbij u dezelfde indeling gebruikt als het veld machtigingen :

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

Als u hosts wilt aanvragen die u alleen tijdens runtime ontdekt, voegt u "https://*/*" toe aan het veld optional_host_permissions van uw extensie. Hiermee kunt u elke oorsprong in Permissions.origins opgeven, zolang deze maar een overeenkomend schema heeft.

Machtigingen die niet als optioneel kunnen worden opgegeven

De meeste machtigingen voor Chrome-extensies kunnen als optioneel worden opgegeven, met de volgende uitzonderingen.

Bekijk Machtigingen declareren en gebruikers waarschuwen voor meer informatie over beschikbare machtigingen en de bijbehorende waarschuwingen.

Stap 3: Vraag optionele machtigingen aan

Vraag de rechten op vanuit een gebruikersgebaar met behulp van 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 waarschuwt de gebruiker als het toevoegen van de rechten resulteert in andere waarschuwingsberichten dan de gebruiker al heeft gezien en geaccepteerd. De vorige code kan bijvoorbeeld een prompt als deze opleveren:

Stap 4: Controleer de huidige machtigingen van de extensie

Om te controleren of uw extensie een specifieke machtiging of set machtigingen heeft, gebruikt u 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.
  }
});

Stap 5: Verwijder de machtigingen

U moet machtigingen verwijderen wanneer u ze niet langer nodig hebt. Nadat een machtiging is verwijderd, wordt deze door het aanroepen van permissions.request() meestal weer teruggeplaatst zonder de gebruiker te vragen.

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,
): Promise<boolean>

chrome.permissions.getAll(
  callback?: function,
): Promise<Permissions>

chrome.permissions.remove(
  permissions: Permissions,
  callback?: function,
): Promise<boolean>

chrome.permissions.request(
  permissions: Permissions,
  callback?: function,
): Promise<boolean>

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

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