browser.management

Beschrijving

De chrome.management API biedt manieren om geïnstalleerde apps en extensies te beheren.

Rechten

management

Je moet het recht 'management' definiëren in het extensiemanifest om de Management API te gebruiken. Voorbeeld:

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

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

Typen

ExtensionDisabledReason

Chrome 44+ browser.* sinds Chrome 148

De reden waarom het item is uitgezet.

Enum

onbekend

"permissions_increase"

ExtensionInfo

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

Eigenschappen

  • appLaunchUrl

    tekenreeks optioneel

    De start-URL (alleen aanwezig voor apps).

  • availableLaunchTypes

    LaunchType[] optioneel

    De op dit moment beschikbare lanceringstypen (alleen aanwezig voor apps).

  • beschrijving

    tekenreeks

    De beschrijving van deze extensie, app of dit thema.

  • disabledReason

    ExtensionDisabledReason optioneel

    De reden waarom het item is uitgezet.

  • aangezet

    booleaans

    Of de functie op dit moment aan- of uitstaat.

  • homepageUrl

    tekenreeks optioneel

    De URL van de homepage van deze extensie, app of dit thema.

  • hostPermissions

    tekenreeks[]

    Retourneert een lijst met op host gebaseerde rechten.

  • iconen

    IconInfo[] optioneel

    Een lijst met icooninformatie. Dit weerspiegelt alleen wat is aangegeven in het manifest. De werkelijke afbeelding op die URL kan groter of kleiner zijn dan wat is aangegeven. Je kunt overwegen expliciete kenmerken voor breedte en hoogte te gebruiken in img-tags die naar deze afbeeldingen verwijzen. Ga naar de manifestdocumentatie over iconen voor meer informatie.

  • id

    tekenreeks

    De unieke ID van de extensie.

  • installType

    ExtensionInstallType

    Hoe de extensie is geïnstalleerd.

  • isApp

    booleaans

    Beëindigd

    Gebruik management.ExtensionInfo.type.

    Waar als dit een app is.

  • launchType

    LaunchType optioneel

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

  • mayDisable

    booleaans

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

  • mayEnable

    booleaans optioneel

    Chrome 62+ browser.* sinds Chrome 148

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

  • name

    tekenreeks

    De naam van deze extensie, app of dit thema.

  • offlineEnabled

    booleaans

    Of de extensie, app of het thema aangeeft dat deze offline ondersteunt.

  • optionsUrl

    tekenreeks

    De URL voor de optiepagina van het item, als deze bestaat.

  • rechten

    tekenreeks[]

    Retourneert een lijst met API-gebaseerde rechten.

  • shortName

    tekenreeks

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

  • Het type van deze extensie, app of dit thema.

  • updateUrl

    tekenreeks optioneel

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

  • versie

    tekenreeks

    De versie van deze extensie, app of dit thema.

  • versionName

    tekenreeks optioneel

    Chrome 50+ browser.* sinds Chrome 148

    De versienaam van deze extensie, app of dit thema als het manifest er een heeft gespecificeerd.

ExtensionInstallType

Chrome 44+ browser.* sinds Chrome 148

Hoe de extensie is geïnstalleerd. Een van de volgende: admin: De extensie is geïnstalleerd vanwege een beheerdersbeleid. 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

"admin"

"development"

"normal"

sideload

"other"

ExtensionType

Chrome 44+ browser.* sinds Chrome 148

Het type van deze extensie, app of dit thema.

Enum

"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

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

Eigenschappen

  • maat

    getal

    Een getal dat de breedte en hoogte van het icoon aangeeft. Mogelijke waarden zijn (maar zijn niet beperkt tot) 128, 48, 24 en 16.

  • url

    tekenreeks

    De URL voor deze icoonafbeelding. Als je een versie van het icoon in grijstinten wilt weergeven (bijvoorbeeld om aan te geven dat een extensie is uitgezet), voeg je ?grayscale=true toe aan de URL.

LaunchType

Dit zijn alle mogelijke typen app-lanceringen.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88+ browser.* sinds Chrome 148

Opties voor hoe de verwijdering van de extensie moet worden afgehandeld.

Eigenschappen

  • showConfirmDialog

    booleaans optioneel

    Of er een dialoogvenster voor het bevestigen van de verwijdering aan de gebruiker moet worden getoond. De standaard is onwaar voor zelf verwijderen. Als een extensie een andere extensie verwijdert, wordt deze parameter genegeerd en wordt het dialoogvenster altijd getoond.

Methoden

createAppShortcut()

browser.management.createAppShortcut(
  id: string,
): Promise<void>

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

Parameters

Retourzendingen

  • Promise<void>

    Chrome 88+ browser.* sinds Chrome 148 
browser.management.generateAppForLink(
  url: string,
  title: string,
): Promise<ExtensionInfo>

Een app genereren voor een URL. Retourneert de gegenereerde bookmark-app.

Parameters

  • url

    tekenreeks

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

  • titel

    tekenreeks

    De titel van de gegenereerde app.

Retourzendingen

get()

browser.management.get(
  id: string,
): Promise<ExtensionInfo>

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

Parameters

Retourzendingen

getAll()

browser.management.getAll(): Promise<ExtensionInfo[]>

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

Retourzendingen

  • Promise<ExtensionInfo[]>

    Chrome 88+ browser.* sinds Chrome 148

getPermissionWarningsById()

browser.management.getPermissionWarningsById(
  id: string,
): Promise<string[]>

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

Parameters

  • id

    tekenreeks

    De ID van een al geïnstalleerde extensie.

Retourzendingen

  • Promise<string[]>

    Chrome 88+ browser.* sinds Chrome 148

getPermissionWarningsByManifest()

browser.management.getPermissionWarningsByManifest(
  manifestStr: string,
): Promise<string[]>

Retourneert een lijst met rechtenwaarschuwingen voor de opgegeven manifesttekenreeks van de extensie. Opmerking: Je kunt deze functie gebruiken zonder het recht 'management' aan te vragen in het manifest.

Parameters

  • manifestStr

    tekenreeks

    Json-tekenreeks voor extensiemanifest.

Retourzendingen

  • Promise<string[]>

    Chrome 88+ browser.* sinds Chrome 148

getSelf()

browser.management.getSelf(): Promise<ExtensionInfo>

Retourneert informatie over de aanroepende extensie, app of het aanroepende thema. Opmerking: Je kunt deze functie gebruiken zonder het recht 'management' aan te vragen in het manifest.

Retourzendingen

installReplacementWebApp()

Chrome 77 of hoger browser.* sinds Chrome 148 
browser.management.installReplacementWebApp(): Promise<void>

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

Retourzendingen

  • Promise<void>

    Chrome 88+ browser.* sinds Chrome 148

launchApp()

browser.management.launchApp(
  id: string,
): Promise<void>

Start een app.

Parameters

  • id

    tekenreeks

    De extensie-ID van de app.

Retourzendingen

  • Promise<void>

    Chrome 88+ browser.* sinds Chrome 148

setEnabled()

browser.management.setEnabled(
  id: string,
  enabled: boolean,
): Promise<void>

Zet een app of extensie aan 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 systeemeigen bevestigings-UI krijgen om misbruik te voorkomen.

Parameters

  • id

    tekenreeks

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

  • aangezet

    booleaans

    Of dit item aan of uit moet staan.

Retourzendingen

  • Promise<void>

    Chrome 88+ browser.* sinds Chrome 148

setLaunchType()

browser.management.setLaunchType(
  id: string,
  launchType: LaunchType,
): Promise<void>

Stel het lanceringstype van een app in.

Parameters

Retourzendingen

  • Promise<void>

    Chrome 88+ browser.* sinds Chrome 148

uninstall()

browser.management.uninstall(
  id: string,
  options?: UninstallOptions,
): Promise<void>

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

Parameters

Retourzendingen

  • Promise<void>

    Chrome 88+ browser.* sinds Chrome 148

uninstallSelf()

browser.management.uninstallSelf(
  options?: UninstallOptions,
): Promise<void>

Hiermee wordt de bel-extensie verwijderd. Opmerking: Je kunt deze functie gebruiken zonder het recht 'management' aan te vragen in het manifest. Deze functie werkt niet in beheerde omgevingen als de gebruiker de opgegeven extensie/app niet mag verwijderen.

Parameters

Retourzendingen

  • Promise<void>

    Chrome 88+ browser.* sinds Chrome 148

Evenementen

onDisabled

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

Wordt geactiveerd als een app of extensie is uitgezet.

Parameters

onEnabled

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

Wordt geactiveerd als een app of extensie is aangezet.

Parameters

onInstalled

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

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

Parameters

onUninstalled

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

Wordt geactiveerd als een app of extensie is verwijderd.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (id: string) => void

    • id

      tekenreeks