chrome.management

Beschreibung

Mit der chrome.management API können Sie die Liste der installierten und ausgeführten Erweiterungen/Apps verwalten. Dies ist besonders nützlich für Erweiterungen, die die integrierte „Neuer Tab“-Seite überschreiben.

Berechtigungen

management

Sie müssen die Verwaltungsberechtigung im Erweiterungsmanifest deklarieren, um die Verwaltungs-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

Ein Grund für die Deaktivierung des Artikels.

Enum

ExtensionInfo

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

Attribute

  • appLaunchUrl

    String optional

    Start-URL (nur für Apps vorhanden)

  • availableLaunchTypes

    LaunchType[] optional

    Aktuell verfügbare Einführungstypen (nur für Apps vorhanden)

  • Beschreibung

    String

    Die Beschreibung der Erweiterung, App oder des Designs.

  • disabledReason

    ExtensionDisabledReason optional

    Ein Grund für die Deaktivierung des Artikels.

  • aktiviert

    boolean

    Gibt an, 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 mit hostbasierten Berechtigungen zurück.

  • Symbole

    IconInfo[] optional

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

  • id

    String

    Die eindeutige ID der Erweiterung.

  • installType

    ExtensionInstallType

    Die Installationsweise der Erweiterung.

  • 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 vorhanden)

  • mayDisable

    boolean

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

  • mayEnable

    Boolescher Wert optional

    Chrome 62 und höher

    Gibt an, ob diese Erweiterung vom Nutzer aktiviert werden kann. Dieser Fehler wird nur für nicht aktivierte Erweiterungen zurückgegeben.

  • name

    String

    Der Name der Erweiterung, der App oder des Designs.

  • offlineEnabled

    boolean

    Gibt an, ob für die Erweiterung, die App oder das Design die Offline-Unterstützung bestätigt wird.

  • optionsUrl

    String

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

  • Berechtigungen

    String[]

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

  • shortName

    String

    Eine Kurzversion des Namens dieser Erweiterung, App oder eines 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 oder höher

    Der Versionsname dieser Erweiterung, App oder Designs, falls im Manifest eine solche angegeben wurde.

ExtensionInstallType

Chrome 44 und höher

Die Installationsweise der Erweiterung. Eine der folgenden Methoden: 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 einer anderen Software auf dem Computer installiert. other: Die Erweiterung wurde auf andere Weise installiert.

Enum

"normal"

ExtensionType

Chrome 44 und höher

Der Typ dieser Erweiterung, App oder dieses Designs.

Enum

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"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 eine Version des Symbols in Graustufen angezeigt werden soll, beispielsweise um anzugeben, dass eine Erweiterung deaktiviert ist, hängen Sie ?grayscale=true an die URL an.

LaunchType

Das sind alles mögliche App-Start-Typen.

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

    Boolescher Wert optional

    Gibt an, ob der Nutzer über ein Dialogfeld zum Bestätigen des Deinstallierens aufgefordert werden soll. Bei eigenständigen Deinstallationen ist die Standardeinstellung „false“. Wird eine andere Erweiterung von einer Erweiterung deinstalliert, wird dieser Parameter ignoriert und das Dialogfeld immer angezeigt.

Methoden

createAppShortcut()

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

Anzeigeoptionen zum Erstellen von Verknüpfungen für eine App. Auf einem Mac können nur gepackte App-Verknüpfungen erstellt werden.

Parameters

  • id

    String

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

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

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

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

Parameters

  • 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

Rückgaben

  • Promise<ExtensionInfo>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

get()

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

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

Parameters

Rückgaben

  • Promise<ExtensionInfo>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

getAll()

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

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

Parameters

Rückgaben

  • Promise<ExtensionInfo[]>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

getPermissionWarningsById()

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

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

Parameters

  • id

    String

    Die ID einer bereits installierten Erweiterung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (permissionWarnings: string[])=>void

    • permissionWarnings

      String[]

Rückgaben

  • Versprechen<string[]>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

getPermissionWarningsByManifest()

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

Gibt eine Liste mit Berechtigungswarnungen für den angegebenen Manifest-String der Erweiterung zurück. Hinweis: Diese Funktion kann verwendet werden, ohne im Manifest die Berechtigung „Verwaltung“ anzufordern.

Parameters

  • manifestStr

    String

    JSON-String des Erweiterungsmanifests.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (permissionWarnings: string[])=>void

    • permissionWarnings

      String[]

Rückgaben

  • Versprechen<string[]>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

getSelf()

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

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

Parameters

Rückgaben

  • Promise<ExtensionInfo>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

installReplacementWebApp()

Versprechen Chrome 77 oder höher 
chrome.management.installReplacementWebApp(
  callback?: function,
)

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

Parameters

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

launchApp()

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

Startet eine Anwendung.

Parameters

  • id

    String

    Die Erweiterungs-ID der Anwendung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

setEnabled()

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

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) und kann dem Nutzer eine native Bestätigungsoberfläche anzeigen, um Missbrauch zu verhindern.

Parameters

  • 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

Rückgaben

  • Promise<void>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

setLaunchType()

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

Legen Sie den Starttyp einer App fest.

Parameters

  • id

    String

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

  • launchType

    LaunchType

    Der Zielstarttyp. Achten Sie immer darauf, dass diese Art der Einführung in ExtensionInfo.availableLaunchTypes angegeben ist, da die verfügbaren Starttypen je nach Plattform und Konfiguration variieren.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

uninstall()

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

Deinstalliert eine derzeit 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 das Dialogfeld abbricht), wird das Promise abgelehnt oder der Callback wird mit runtime.lastError aufgerufen.

Parameters

Rückgaben

  • Promise<void>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

uninstallSelf()

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

Die Anruferweiterung wird deinstalliert. Hinweis: Diese Funktion kann verwendet werden, ohne im Manifest die Berechtigung „Verwaltung“ anzufordern. Diese Funktion funktioniert nicht in verwalteten Umgebungen, in denen der Nutzer die angegebene Erweiterung oder App nicht deinstallieren darf.

Parameters

  • Optionen

    UninstallOptions optional

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 88 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

Veranstaltungen

onDisabled

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

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

Parameters

onEnabled

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

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

Parameters

onInstalled

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

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

Parameters

onUninstalled

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

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

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (id: string)=>void

    • id

      String