chrome.permissions

Beschrijving

Overzicht

Er bestaan ​​toestemmingswaarschuwingen om de mogelijkheden te beschrijven die door een API worden verleend, maar sommige van deze waarschuwingen zijn misschien niet voor de hand liggend. Met de Permissions API kunnen ontwikkelaars toestemmingswaarschuwingen uitleggen en geleidelijk nieuwe functies introduceren, waardoor gebruikers een risicovrije introductie tot de extensie krijgen. Op deze manier kunnen gebruikers opgeven hoeveel toegang ze willen verlenen en welke functies ze willen inschakelen.

De kernfunctionaliteit van de optionele machtigingsextensie overschrijft bijvoorbeeld de nieuwe tabbladpagina. Eén functie is het weergeven van het doel van de dag van de gebruiker. Voor deze functie zijn alleen opslagrechten vereist, die geen waarschuwing bevatten. De extensie heeft een extra functie die gebruikers kunnen inschakelen door op de volgende knop te klikken:

Voor het weergeven van de topsites van de gebruiker is de toestemming topSites vereist, die de volgende waarschuwing bevat.

Optionele machtigingen implementeren

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

Een extensie kan zowel vereiste als optionele machtigingen declareren. Over het algemeen moet u:

• 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 prompts: een extensie kan de gebruiker één keer vragen om alle machtigingen te accepteren.
• Eenvoudiger ontwikkelen: de vereiste machtigingen zijn gegarandeerd aanwezig.

Voordelen van optionele machtigingen:

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

Stap 2: Declareer optionele machtigingen in het manifest

Declareer optionele machtigingen in uw extensiemanifest met de optional_permissions sleutel, met dezelfde indeling als het machtigingsveld :

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

Als u hosts wilt aanvragen die u alleen tijdens runtime ontdekt, neemt u "https://*/*" op in 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 hun waarschuwingen.

Stap 3: Vraag optionele machtigingen aan

Vraag de machtigingen aan 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 vraagt ​​de gebruiker of het toevoegen van de rechten resulteert in andere waarschuwingsberichten dan de gebruiker al heeft gezien en geaccepteerd. De vorige code kan bijvoorbeeld resulteren in een prompt als deze:

Stap 4: Controleer de huidige rechten van de extensie

Om te controleren of uw extensie een specifieke machtiging of een reeks 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 deze niet langer nodig heeft. Nadat een machtiging is verwijderd, wordt door het aanroepen permissions.request() de machtiging doorgaans weer toegevoegd zonder dat de gebruiker hierom wordt gevraagd.

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