chrome.management

Beschrijving

Met de chrome.management API kunt u geïnstalleerde apps en extensies beheren.

Machtigingen

management

Manifest

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

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

management.getPermissionWarningsByManifest , management.uninstallSelf en management.getSelf hebben geen beheermachtiging nodig.

Typen

ExtensionDisabledReason

Chroom 44+

Een reden waarom het item is uitgeschakeld.

Enum

"onbekend"

"machtigingen_toenemen"

ExtensionInfo

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

Eigenschappen

  • appLaunchUrl

    string 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.

  • uitgeschakeldeReason

    ExtensionDisabledReason optioneel

    Een reden waarom het item is uitgeschakeld.

  • ingeschakeld

    Booleaanse

    Of deze momenteel is ingeschakeld of uitgeschakeld.

  • startpaginaUrl

    string optioneel

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

  • hostPermissions

    snaar[]

    Retourneert een lijst met op de host gebaseerde machtigingen.

  • iconen

    IconInfo [] optioneel

    Een lijst met pictograminformatie. Houd er rekening mee dat dit alleen weergeeft wat er in het manifest is gedeclareerd en dat de daadwerkelijke afbeelding op die URL groter of kleiner kan zijn dan wat er is gedeclareerd. U kunt daarom overwegen om expliciete breedte- en hoogtekenmerken te gebruiken voor img-tags die naar deze afbeeldingen verwijzen. Zie de manifestdocumentatie over pictogrammen voor meer informatie.

  • id

    snaar

    De unieke identificatie van de extensie.

  • installatieType

    ExtensieInstallatieType

    Hoe de extensie is geïnstalleerd.

  • isApp

    Booleaanse

    Verouderd

    Gebruik management.ExtensionInfo.type .

    Waar als dit een app is.

  • lanceringstype

    LaunchType optioneel

    Het type app-opstart (alleen aanwezig voor apps).

  • kanUitschakelen

    Booleaanse

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

  • kanInschakelen

    boolean 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

    Booleaanse

    Of de extensie, app of thema aangeeft dat het offline ondersteuning biedt.

  • optiesUrl

    snaar

    De URL voor de optiepagina van het item, indien aanwezig.

  • toestemmingen

    snaar[]

    Retourneert een lijst met API-gebaseerde machtigingen.

  • korteNaam

    snaar

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

  • Het type van deze extensie, app of thema.

  • update-URL

    string optioneel

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

  • versie

    snaar

    De versie van deze extensie, app of thema.

  • versienaam

    string optioneel

    Chroom 50+

    De versienaam van deze extensie, app of thema, indien gespecificeerd in het manifest.

ExtensionInstallType

Chroom 44+

Hoe de extensie is geïnstalleerd. admin : De extensie is geïnstalleerd vanwege een administratief beleid. development : De extensie is uitgepakt geladen in de 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"

"inlogschermextensie"

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 aangeeft. Mogelijke waarden zijn (maar zijn niet beperkt tot) 128, 48, 24 en 16.

  • url

    snaar

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

LaunchType

Dit zijn allemaal mogelijke manieren om een app te starten.

Enum

"OPEN_ALS_REGELMATIGE_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_ALS_VENSTER"

"VOLLEDIG_OPEN_SCHERM"

UninstallOptions

Chroom 88+

Opties voor het verwijderen van de extensie.

Eigenschappen

  • showConfirmDialog

    boolean optioneel

    Of er een dialoogvenster voor het bevestigen van de verwijdering aan de gebruiker moet worden getoond. Standaard is dit false voor zelfverwijderingen. 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,
): Promise<void>

Weergaveopties voor het maken van snelkoppelingen voor een app. Op Mac kunnen alleen snelkoppelingen voor standaardapps worden gemaakt.

Parameters

  • id

    snaar

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

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Belofte
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
): Promise<ExtensionInfo>

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

Parameters

  • url

    snaar

    De URL van een webpagina. De URL kan alleen de vorm "http" of "https" hebben.

  • titel

    snaar

    De titel van de gegenereerde app.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (result: ExtensionInfo) => void

Retourneren

  • Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

get()

Belofte
chrome.management.get(
  id: string,
  callback?: function,
): Promise<ExtensionInfo>

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

Parameters

Retourneren

  • Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getAll()

Belofte
chrome.management.getAll(
  callback?: function,
): Promise<ExtensionInfo[]>

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

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (result: ExtensionInfo[]) => void

Retourneren

  • Belofte< ExtensionInfo []>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getPermissionWarningsById()

Belofte
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
): Promise<string[]>

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

Parameters

  • id

    snaar

    De ID van een reeds geïnstalleerde extensie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (permissionWarnings: string[]) => void

    • toestemmingWaarschuwingen

      snaar[]

Retourneren

  • Belofte<string[]>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getPermissionWarningsByManifest()

Belofte
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
): Promise<string[]>

Retourneert een lijst met toestemmingswaarschuwingen voor de opgegeven extensiemanifeststring. Opmerking: deze functie kan worden gebruikt zonder de 'management'-machtiging in het manifest aan te vragen.

Parameters

  • manifestStr

    snaar

    JSON-tekenreeks voor extensiemanifest.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (permissionWarnings: string[]) => void

    • toestemmingWaarschuwingen

      snaar[]

Retourneren

  • Belofte<string[]>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getSelf()

Belofte
chrome.management.getSelf(
  callback?: function,
): Promise<ExtensionInfo>

Retourneert informatie over de aanroepende extensie, app of thema. Opmerking: Deze functie kan worden gebruikt zonder dat de beheermachtiging in het manifest hoeft te worden aangevraagd.

Parameters

Retourneren

  • Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

installReplacementWebApp()

BelofteChrome 77+
chrome.management.installReplacementWebApp(
  callback?: function,
): Promise<void>

Start de in het manifest gespecificeerde replacement_web_app. Vraagt de gebruiker om deze te installeren als deze nog niet is geïnstalleerd.

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

launchApp()

Belofte
chrome.management.launchApp(
  id: string,
  callback?: function,
): Promise<void>

Start een applicatie.

Parameters

  • id

    snaar

    De extensie-ID van de applicatie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setEnabled()

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

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 native bevestigingsinterface bieden om misbruik te voorkomen.

Parameters

  • id

    snaar

    Dit zou de id moeten zijn van een item van management.ExtensionInfo .

  • ingeschakeld

    Booleaanse

    Of dit item moet worden in- of uitgeschakeld.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setLaunchType()

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

Stel het starttype van een app in.

Parameters

  • id

    snaar

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

  • lanceringstype

    Lanceertype

    Het beoogde starttype. Controleer altijd of dit starttype in ExtensionInfo.availableLaunchTypes staat, omdat de beschikbare starttypen per platform en configuratie verschillen.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

uninstall()

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

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

Parameters

Retourneren

  • Belofte<leegte>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

uninstallSelf()

Belofte
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
): Promise<void>

Verwijdert de aanroepende extensie. Opmerking: Deze functie kan worden gebruikt zonder de beheermachtiging in het manifest aan te vragen. Deze functie werkt niet in beheerde omgevingen wanneer de gebruiker de opgegeven extensie/app niet mag verwijderen.

Parameters

  • opties

    UninstallOptions optioneel

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 88+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

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

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (id: string) => void

    • id

      snaar