chrome.management

Beschrijving

De chrome.management API biedt manieren om de lijst met extensies/apps te beheren die zijn geïnstalleerd en actief zijn. Het is vooral handig voor extensies die de ingebouwde Nieuw-tabbladpagina overschrijven .

Rechten

management

U moet de machtiging 'beheer' opgeven in het extensiemanifest om de beheer-API te kunnen gebruiken. Bijvoorbeeld:

{
  "name": "My extension",
  ...
  "permissions": [
    "management"
  ],
  ...
}

management.getPermissionWarningsByManifest() , management.uninstallSelf() en management.getSelf() vereisen geen beheermachtiging.

Soorten

ExtensionDisabledReason

Chroom 44+

Een reden waarom het item is uitgeschakeld.

Enum

"onbekend"

"toestemmingen_verhogen"

ExtensionInfo

Informatie over een geïnstalleerde extensie, app of thema.

Eigenschappen

  • appLaunchUrl

    tekenreeks optioneel

    De start-URL (alleen aanwezig voor apps).

  • beschikbareLaunchTypes

    LaunchType [] optioneel

    De momenteel beschikbare opstarttypen (alleen aanwezig voor apps).

  • beschrijving

    snaar

    De beschrijving van deze extensie, app of thema.

  • uitgeschakeldReden

    ExtensionDisabledReason optioneel

    Een reden waarom het item is uitgeschakeld.

  • ingeschakeld

    Booleaans

    Of het momenteel is ingeschakeld of uitgeschakeld.

  • Startpagina URL

    tekenreeks optioneel

    De URL van de startpagina van deze extensie, app of thema.

  • hostmachtigingen

    snaar[]

    Retourneert een lijst met hostgebaseerde machtigingen.

  • pictogrammen

    IconInfo [] optioneel

    Een lijst met pictograminformatie. Houd er rekening mee dat dit slechts weerspiegelt wat er in het manifest is gedeclareerd, en dat de werkelijke afbeelding op die url groter of kleiner kan zijn dan wat is gedeclareerd. U kunt dus overwegen om expliciete breedte- en hoogte-attributen te gebruiken op img-tags die naar deze afbeeldingen verwijzen. Zie de manifestdocumentatie over pictogrammen voor meer details.

  • ID kaart

    snaar

    De unieke ID van de extensie.

  • installatietype

    ExtensieInstallType

    Hoe de extensie is geïnstalleerd.

  • isApp

    Booleaans

    Verouderd

    Gebruik management.ExtensionInfo.type .

    Klopt als dit een app is.

  • launchType

    LaunchType optioneel

    Het app-opstarttype (alleen aanwezig voor apps).

  • meiUitschakelen

    Booleaans

    Of deze extensie door de gebruiker kan worden uitgeschakeld of verwijderd.

  • kanInschakelen

    Booleaans optioneel

    Chroom 62+

    Of deze extensie door de gebruiker kan worden ingeschakeld. Dit wordt alleen geretourneerd voor extensies die niet zijn ingeschakeld.

  • naam

    snaar

    De naam van deze extensie, app of thema.

  • offlineIngeschakeld

    Booleaans

    Of de extensie, app of thema aangeeft offline ondersteuning te bieden.

  • optiesUrl

    snaar

    De URL voor de optiepagina van het item, als die er is.

  • rechten

    snaar[]

    Retourneert een lijst met API-gebaseerde machtigingen.

  • korte naam

    snaar

    Een korte versie van de naam van deze extensie, app of thema.

  • Het type van deze extensie, app of thema.

  • updateUrl

    tekenreeks optioneel

    De update-URL van deze extensie, app of thema.

  • versie

    snaar

    De versie van deze extensie, app of thema.

  • versieNaam

    tekenreeks optioneel

    Chroom 50+

    De versienaam van deze extensie, app of thema als het manifest dit specificeert.

ExtensionInstallType

Chroom 44+

Hoe de extensie is geïnstalleerd. Een van admin : de extensie is geïnstalleerd vanwege een beheerdersbeleid, development : de extensie is uitgepakt geladen in ontwikkelaarsmodus, normal : de extensie is normaal geïnstalleerd via een .crx-bestand, sideload : de extensie is geïnstalleerd door andere software op de machine , other : de extensie is op een andere manier geïnstalleerd.

Enum

"beheerder"

"ontwikkeling"

"normaal"

"zijbelasting"

"ander"

ExtensionType

Chroom 44+

Het type van deze extensie, app of thema.

Enum

"verlenging"

"gehoste_app"

"verpakte_app"

"legacy_packaged_app"

"thema"

"inlogscherm_extensie"

IconInfo

Informatie over een pictogram dat bij een extensie, app of thema hoort.

Eigenschappen

  • maat

    nummer

    Een getal dat de breedte en hoogte van het pictogram vertegenwoordigt. Waarschijnlijke waarden omvatten (maar zijn niet beperkt tot) 128, 48, 24 en 16.

  • URL

    snaar

    De URL voor deze pictogramafbeelding. Als u een grijswaardenversie van het pictogram wilt weergeven (bijvoorbeeld om aan te geven dat een extensie is uitgeschakeld), voegt u ?grayscale=true toe aan de URL.

LaunchType

Dit zijn allemaal mogelijke typen app-lancering.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chroom 88+

Opties voor het afhandelen van het verwijderen van de extensie.

Eigenschappen

  • toonBevestigDialoog

    Booleaans optioneel

    Of de gebruiker wel of niet in een dialoogvenster voor het bevestigen en verwijderen moet worden gevraagd. Standaard ingesteld op false voor zelfinstallaties. Als een extensie een andere extensie verwijdert, wordt deze parameter genegeerd en wordt het dialoogvenster altijd weergegeven.

Methoden

createAppShortcut()

Belofte
chrome.management.createAppShortcut(
  id: string,
  callback?: function,
)

Opties weergeven om snelkoppelingen voor een app te maken. Op de Mac kunnen alleen snelkoppelingen voor verpakte apps worden gemaakt.

Parameters

  • ID kaart

    snaar

    Dit moet de ID zijn van een app-item van management.ExtensionInfo .

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Belofte
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
)

Genereer een app voor een URL. Retourneert de gegenereerde bladwijzer-app.

Parameters

  • URL

    snaar

    De URL van een webpagina. Het schema van de URL kan alleen "http" of "https" zijn.

  • titel

    snaar

    De titel van de gegenereerde app.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: ExtensionInfo)=>void

Geeft terug

  • Beloof < ExtensieInfo >

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

get()

Belofte
chrome.management.get(
  id: string,
  callback?: function,
)

Retourneert informatie over de geïnstalleerde extensie, app of thema met de opgegeven ID.

Parameters

Geeft terug

  • Beloof < ExtensieInfo >

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getAll()

Belofte
chrome.management.getAll(
  callback?: function,
)

Retourneert een lijst met informatie over geïnstalleerde extensies en apps.

Parameters

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: ExtensionInfo[])=>void

Geeft terug

  • Beloof < ExtensieInfo []>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getPermissionWarningsById()

Belofte
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
)

Retourneert een lijst met toestemmingswaarschuwingen voor de opgegeven extensie-ID.

Parameters

  • ID kaart

    snaar

    De ID van een reeds geïnstalleerde extensie.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (permissionWarnings: string[])=>void

    • toestemmingWaarschuwingen

      snaar[]

Geeft terug

  • Beloof<string[]>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getPermissionWarningsByManifest()

Belofte
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
)

Retourneert een lijst met toestemmingswaarschuwingen voor de opgegeven manifestreeks van de extensie. Let op: Deze functie kan worden gebruikt zonder de toestemming 'beheer' in het manifest aan te vragen.

Parameters

  • manifestStr

    snaar

    Extensiemanifest JSON-tekenreeks.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (permissionWarnings: string[])=>void

    • toestemmingWaarschuwingen

      snaar[]

Geeft terug

  • Beloof<string[]>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getSelf()

Belofte
chrome.management.getSelf(
  callback?: function,
)

Retourneert informatie over het beltoestel, de app of het thema. Let op: Deze functie kan worden gebruikt zonder de toestemming 'beheer' in het manifest aan te vragen.

Parameters

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: ExtensionInfo)=>void

Geeft terug

  • Beloof < ExtensieInfo >

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

installReplacementWebApp()

BeloofChrome 77+
chrome.management.installReplacementWebApp(
  callback?: function,
)

Start de replacement_web_app die is opgegeven in het manifest. Vraagt ​​de gebruiker om te installeren als dit nog niet is gebeurd.

Parameters

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

launchApp()

Belofte
chrome.management.launchApp(
  id: string,
  callback?: function,
)

Start een applicatie.

Parameters

  • ID kaart

    snaar

    De extensie-ID van de toepassing.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setEnabled()

Belofte
chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
)

Schakelt een app of extensie in of uit. In de meeste gevallen moet deze functie worden aangeroepen in de context van een gebruikersgebaar (bijvoorbeeld een onclick-handler voor een knop), en kan de gebruiker een eigen bevestigings-UI krijgen als een manier om misbruik te voorkomen.

Parameters

  • ID kaart

    snaar

    Dit moet de ID zijn van een item van management.ExtensionInfo .

  • ingeschakeld

    Booleaans

    Of dit item moet worden in- of uitgeschakeld.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setLaunchType()

Belofte
chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
  callback?: function,
)

Stel het opstarttype van een app in.

Parameters

  • ID kaart

    snaar

    Dit moet de ID zijn van een app-item van management.ExtensionInfo .

  • launchType

    Starttype

    Het doellanceringstype. Controleer altijd en zorg ervoor dat dit opstarttype zich in ExtensionInfo.availableLaunchTypes bevindt, omdat de beschikbare opstarttypen variëren op verschillende platforms en configuraties.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

uninstall()

Belofte
chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
)

Verwijdert een momenteel geïnstalleerde app of extensie. Let op: Deze functie werkt niet in beheerde omgevingen als de gebruiker de opgegeven extensie/app niet mag verwijderen. Als het verwijderen mislukt (de gebruiker annuleert bijvoorbeeld het dialoogvenster), wordt de belofte afgewezen of wordt de callback aangeroepen met runtime.lastError ingesteld.

Parameters

Geeft terug

  • Beloof <nietig>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

uninstallSelf()

Belofte
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
)

Verwijdert de belextensie. Let op: Deze functie kan worden gebruikt zonder de toestemming 'beheer' in het manifest aan te vragen. Deze functie werkt niet in beheerde omgevingen als de gebruiker de opgegeven extensie/app niet mag verwijderen.

Parameters

  • opties

    UninstallOptions optioneel

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 88+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Evenementen

onDisabled

chrome.management.onDisabled.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een app of extensie is uitgeschakeld.

Parameters

onEnabled

chrome.management.onEnabled.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een app of extensie is ingeschakeld.

Parameters

onInstalled

chrome.management.onInstalled.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een app of extensie is geïnstalleerd.

Parameters

onUninstalled

chrome.management.onUninstalled.addListener(
  callback: function,
)

Wordt geactiveerd wanneer een app of extensie is verwijderd.

Parameters

  • Bel terug

    functie

    De callback parameter ziet er als volgt uit: 

    (id: string)=>void

    • ID kaart

      snaar