browser.management

Beschreibung

Die chrome.management API bietet Möglichkeiten zum Verwalten installierter Apps und Erweiterungen.

Berechtigungen

management

Sie müssen die Berechtigung „management“ im Manifest der Erweiterung deklarieren, um die Management API verwenden zu können. Beispiel:

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

Für management.getPermissionWarningsByManifest(), management.uninstallSelf() und management.getSelf() ist die Verwaltungsberechtigung nicht erforderlich.

Typen

ExtensionDisabledReason

Chrome 44 und höher browser.* seit Chrome 148

Der Grund, warum das Element deaktiviert ist.

Enum

"unknown"

"permissions_increase"

ExtensionInfo

Informationen zu einer installierten Erweiterung, App oder einem installierten Design.

Attribute

  • appLaunchUrl

    String optional

    Die Start-URL (nur für Apps vorhanden).

  • availableLaunchTypes

    LaunchType[] optional

    Die derzeit verfügbaren Starttypen (nur für Apps vorhanden).

  • Beschreibung

    String

    Die Beschreibung dieser Erweiterung, App oder dieses Designs.

  • disabledReason

    ExtensionDisabledReason optional

    Der Grund, warum das Element deaktiviert ist.

  • aktiviert

    boolean

    Ob sie derzeit aktiviert oder deaktiviert ist.

  • homepageUrl

    String optional

    Die URL der Startseite dieser Erweiterung, App oder dieses Designs.

  • hostPermissions

    String[]

    Gibt eine Liste der hostbasierten Berechtigungen zurück.

  • Symbole

    IconInfo[] optional

    Eine Liste mit Symbolinformationen. Beachten Sie, dass dies nur die Angaben im Manifest widerspiegelt. Das tatsächliche Bild unter dieser URL kann größer oder kleiner als angegeben sein. Sie sollten daher explizite Breiten- und Höhenattribute für img-Tags verwenden, die auf diese Bilder verweisen. Weitere Informationen finden Sie in der Manifestdokumentation zu Symbolen.

  • id

    String

    Die eindeutige Kennung der Erweiterung.

  • installType

    ExtensionInstallType

    Wie die Erweiterung installiert wurde.

  • isApp

    boolean

    Eingestellt

    Bitte verwende management.ExtensionInfo.type.

    „True“, wenn es sich um eine App handelt.

  • launchType

    LaunchType optional

    Der App-Starttyp (nur für Apps vorhanden).

  • mayDisable

    boolean

    Gibt an, ob diese Erweiterung vom Nutzer deaktiviert oder deinstalliert werden kann.

  • mayEnable

    Boolesch optional

    Chrome 62 und höher browser.* seit Chrome 148

    Gibt an, ob diese Erweiterung vom Nutzer aktiviert werden kann. Dies wird nur für Erweiterungen zurückgegeben, die nicht aktiviert sind.

  • name

    String

    Der Name dieser Erweiterung, App oder dieses Designs.

  • offlineEnabled

    boolean

    Ob die Erweiterung, App oder das Design angibt, dass sie/es offline unterstützt wird.

  • optionsUrl

    String

    Die URL für die Optionsseite des Elements, falls vorhanden.

  • Berechtigungen

    String[]

    Gibt eine Liste der API-basierten Berechtigungen zurück.

  • shortName

    String

    Eine Kurzversion des Namens dieser Erweiterung, App oder dieses Designs.

  • Der Typ dieser Erweiterung, App oder dieses Designs.

  • updateUrl

    String optional

    Die Update-URL dieser Erweiterung, App oder dieses Designs.

  • Version

    String

    Die Version dieser Erweiterung, App oder dieses Designs.

  • versionName

    String optional

    Chrome 50 und höher browser.* seit Chrome 148

    Der Versionsname dieser Erweiterung, App oder dieses Designs, sofern im Manifest angegeben.

ExtensionInstallType

Chrome 44 und höher browser.* seit Chrome 148

Wie die Erweiterung installiert wurde. Eine der folgenden Optionen: admin: Die Erweiterung wurde aufgrund einer Verwaltungsrichtlinie installiert. development: Die Erweiterung wurde im Entwicklermodus entpackt geladen. normal: Die Erweiterung wurde normal über eine CRX-Datei installiert. sideload: Die Erweiterung wurde von anderer Software auf dem Computer installiert. other: Die Erweiterung wurde auf andere Weise installiert.

Enum

"admin"

"development"

"normal"

"sideload"

"other"

ExtensionType

Chrome 44 und höher browser.* seit Chrome 148

Der Typ dieser Erweiterung, App oder dieses Designs.

Enum

"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

Informationen zu einem Symbol, das zu einer Erweiterung, App oder einem Design gehört.

Attribute

  • Größe

    Zahl

    Eine Zahl, die die Breite und Höhe des Symbols darstellt. Mögliche Werte sind unter anderem 128, 48, 24 und 16.

  • URL

    String

    Die URL für dieses Symbolbild. Wenn Sie eine Graustufenversion des Symbols anzeigen möchten, um beispielsweise anzugeben, dass eine Erweiterung deaktiviert ist, hängen Sie ?grayscale=true an die URL an.

LaunchType

Dies sind alle möglichen App-Starttypen.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88 oder höher browser.* seit Chrome 148

Optionen für die Deinstallation der Erweiterung.

Attribute

  • showConfirmDialog

    Boolesch optional

    Gibt an, ob der Nutzer ein Dialogfeld zur Bestätigung der Deinstallation sehen soll. Die Standardeinstellung ist „false“ für die Deinstallation durch den Nutzer. Wenn eine Erweiterung eine andere Erweiterung deinstalliert, wird dieser Parameter ignoriert und das Dialogfeld wird immer angezeigt.

Methoden

createAppShortcut()

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

Optionen zum Erstellen von Verknüpfungen für eine App anzeigen. Auf dem Mac können nur Verknüpfungen für gepackte Apps erstellt werden.

Parameter

Ausgabe

  • Promise<void>

    Chrome 88 oder höher browser.* seit Chrome 148 
browser.management.generateAppForLink(
  url: string,
  title: string,
): Promise<ExtensionInfo>

App für eine URL generieren. Gibt die generierte Lesezeichen-App zurück.

Parameter

  • URL

    String

    Die URL einer Webseite. Das Schema der URL kann nur „http“ oder „https“ sein.

  • Titel

    String

    Der Titel der generierten Anwendung.

Ausgabe

  • Promise<ExtensionInfo>

    Chrome 88 oder höher browser.* seit Chrome 148

get()

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

Gibt Informationen zur installierten Erweiterung, App oder zum installierten Design mit der angegebenen ID zurück.

Parameter

Ausgabe

  • Promise<ExtensionInfo>

    Chrome 88 oder höher browser.* seit Chrome 148

getAll()

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

Gibt eine Liste mit Informationen zu installierten Erweiterungen und Apps zurück.

Ausgabe

  • Promise<ExtensionInfo[]>

    Chrome 88 oder höher browser.* seit Chrome 148

getPermissionWarningsById()

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

Gibt eine Liste mit Berechtigungswarnungen für die angegebene Erweiterungs-ID zurück.

Parameter

  • id

    String

    Die ID einer bereits installierten Erweiterung.

Ausgabe

  • Promise<string[]>

    Chrome 88 oder höher browser.* seit Chrome 148

getPermissionWarningsByManifest()

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

Gibt eine Liste mit Berechtigungswarnungen für den angegebenen Manifeststring der Erweiterung zurück. Hinweis: Diese Funktion kann verwendet werden, ohne dass die Berechtigung „management“ im Manifest angefordert werden muss.

Parameter

  • manifestStr

    String

    JSON-String des Erweiterungsmanifests.

Ausgabe

  • Promise<string[]>

    Chrome 88 oder höher browser.* seit Chrome 148

getSelf()

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

Gibt Informationen zur aufrufenden Erweiterung, App oder zum aufrufenden Design zurück. Hinweis: Diese Funktion kann verwendet werden, ohne dass die Berechtigung „management“ im Manifest angefordert werden muss.

Ausgabe

  • Promise<ExtensionInfo>

    Chrome 88 oder höher browser.* seit Chrome 148

installReplacementWebApp()

Chrome 77 oder höher browser.* seit Chrome 148 
browser.management.installReplacementWebApp(): Promise<void>

Startet die im Manifest angegebene replacement_web_app. Der Nutzer wird aufgefordert, die App zu installieren, falls sie noch nicht installiert ist.

Ausgabe

  • Promise<void>

    Chrome 88 oder höher browser.* seit Chrome 148

launchApp()

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

Startet eine Anwendung.

Parameter

  • id

    String

    Die Erweiterungs-ID der Anwendung.

Ausgabe

  • Promise<void>

    Chrome 88 oder höher browser.* seit Chrome 148

setEnabled()

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

Aktiviert oder deaktiviert eine App oder Erweiterung. In den meisten Fällen muss diese Funktion im Kontext einer Nutzergeste aufgerufen werden (z. B. ein Onclick-Handler für eine Schaltfläche). Außerdem kann dem Nutzer eine native Bestätigungs-UI angezeigt werden, um Missbrauch zu verhindern.

Parameter

  • id

    String

    Dies sollte die ID eines Elements von management.ExtensionInfo sein.

  • aktiviert

    boolean

    Gibt an, ob dieses Element aktiviert oder deaktiviert werden soll.

Ausgabe

  • Promise<void>

    Chrome 88 oder höher browser.* seit Chrome 148

setLaunchType()

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

Starttyp einer App festlegen

Parameter

Ausgabe

  • Promise<void>

    Chrome 88 oder höher browser.* seit Chrome 148

uninstall()

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

Deinstalliert eine aktuell installierte App oder Erweiterung. Hinweis: Diese Funktion funktioniert nicht in verwalteten Umgebungen, wenn der Nutzer die angegebene Erweiterung/App nicht deinstallieren darf. Wenn die Deinstallation fehlschlägt (z.B. weil der Nutzer das Dialogfeld abbricht), wird das Promise abgelehnt oder der Callback wird mit runtime.lastError aufgerufen.

Parameter

Ausgabe

  • Promise<void>

    Chrome 88 oder höher browser.* seit Chrome 148

uninstallSelf()

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

Deinstalliert die Anruferweiterung. Hinweis: Diese Funktion kann verwendet werden, ohne dass die Berechtigung „management“ im Manifest angefordert werden muss. Diese Funktion funktioniert in verwalteten Umgebungen nicht, wenn der Nutzer die angegebene Erweiterung oder App nicht deinstallieren darf.

Parameter

Ausgabe

  • Promise<void>

    Chrome 88 oder höher browser.* seit Chrome 148

Ereignisse

onDisabled

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

Wird ausgelöst, wenn eine App oder Erweiterung deaktiviert wurde.

Parameter

onEnabled

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

Wird ausgelöst, wenn eine App oder Erweiterung aktiviert wurde.

Parameter

onInstalled

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

Wird ausgelöst, wenn eine App oder Erweiterung installiert wurde.

Parameter

onUninstalled

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

Wird ausgelöst, wenn eine App oder Erweiterung deinstalliert wurde.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (id: string) => void

    • id

      String