chrome.management

Beschreibung

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

Berechtigungen

management

Manifest

Sie müssen die Berechtigung „management“ im Erweiterungsmanifest 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 keine Verwaltungsberechtigung erforderlich.

Typen

ExtensionDisabledReason

Chrome 44 und höher

Ein Grund für die Deaktivierung des Artikels.

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

  • availableLaunchTypes

    LaunchType[] optional

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

  • Beschreibung

    String

    Die Beschreibung dieser Erweiterung, App oder dieses Designs.

  • disabledReason

    ExtensionDisabledReason optional

    Ein Grund für die Deaktivierung des Artikels.

  • aktiviert

    boolean

    Gibt an, ob die Funktion 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. Das Manifest gibt nur an, was deklariert wurde. Das tatsächliche Bild unter dieser URL kann größer oder kleiner als die deklarierte Größe sein. Daher sollten Sie für img-Tags, die auf diese Bilder verweisen, explizite Breiten- und Höhenattribute verwenden. 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

    Verwenden Sie management.ExtensionInfo.type.

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

  • launchType

    LaunchType optional

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

  • mayDisable

    boolean

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

  • mayEnable

    boolean optional

    Chrome 62 und höher

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

  • name

    String

    Der Name dieser Erweiterung, App oder dieses Designs.

  • offlineEnabled

    boolean

    Gibt an, ob die Erweiterung, App oder das Design angibt, dass es Offline-Unterstützung bietet.

  • optionsUrl

    String

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

  • Berechtigungen

    String[]

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

  • shortName

    String

    Eine kurze Version 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

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

ExtensionInstallType

Chrome 44 und höher

Wie die Erweiterung installiert wurde. Einer der folgenden Werte: admin: Die Erweiterung wurde aufgrund einer administrativen Richtlinie installiert. development: Die Erweiterung wurde im Entwicklermodus entpackt geladen. normal: Die Erweiterung wurde regulär ü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"

„Entwicklung“

"normal"

„Sideload“

"other"

ExtensionType

Chrome 44 und höher

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. Wahrscheinliche 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 (z. B. um 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 und höher

Optionen für die Deinstallation der Erweiterung.

Attribute

  • showConfirmDialog

    boolean optional

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

Methoden

createAppShortcut()

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

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

Parameter

  • id

    String

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

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

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

Eine 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 App.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (result: ExtensionInfo) => void

Ausgabe

  • Promise<ExtensionInfo>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

get()

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

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

Parameter

Ausgabe

  • Promise<ExtensionInfo>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getAll()

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

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

Parameter

Ausgabe

  • Promise<ExtensionInfo[]>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getPermissionWarningsById()

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

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

Parameter

  • id

    String

    Die ID einer bereits installierten Erweiterung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (permissionWarnings: string[]) => void

    • permissionWarnings

      String[]

Ausgabe

  • Promise<string[]>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getPermissionWarningsByManifest()

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

Gibt eine Liste von Berechtigungswarnungen für den angegebenen Erweiterungsmanifeststring zurück. Hinweis: Diese Funktion kann verwendet werden, ohne die Berechtigung „management“ im Manifest anzufordern.

Parameter

  • manifestStr

    String

    JSON-String des Erweiterungsmanifests.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (permissionWarnings: string[]) => void

    • permissionWarnings

      String[]

Ausgabe

  • Promise<string[]>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getSelf()

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

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

Parameter

Ausgabe

  • Promise<ExtensionInfo>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

installReplacementWebApp()

Promise Chrome 77 und höher 
chrome.management.installReplacementWebApp(
  callback?: function,
): Promise<void>

Startet die im Manifest angegebene replacement_web_app. Fordert den Nutzer zur Installation auf, falls die App noch nicht installiert ist.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

launchApp()

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

Startet eine Anwendung.

Parameter

  • id

    String

    Die Erweiterungs-ID der Anwendung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setEnabled()

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

Aktiviert oder deaktiviert eine App oder Erweiterung. In den meisten Fällen muss diese Funktion im Kontext einer Nutzeraktion aufgerufen werden, z. B. in einem 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.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setLaunchType()

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

Starttyp einer App festlegen

Parameter

  • id

    String

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

  • launchType

    LaunchType

    Der Ziel-Launch-Typ. Prüfen Sie immer, ob dieser Starttyp in ExtensionInfo.availableLaunchTypes enthalten ist, da die verfügbaren Starttypen je nach Plattform und Konfiguration variieren.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

uninstall()

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

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

Parameter

Ausgabe

  • Promise<void>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

uninstallSelf()

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

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

Parameter

  • Optionen

    UninstallOptions optional

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 88 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

Ereignisse

onDisabled

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

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

Parameter

onEnabled

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

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

Parameter

onInstalled

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

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

Parameter

onUninstalled

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