chrome.management

Beschreibung

Mit der chrome.management API können Sie installierte Apps und Erweiterungen verwalten.

Berechtigungen

management

Sie müssen die „Verwaltung“ Berechtigung im Erweiterungsmanifest, die Verwaltung zu verwenden der API erstellen. Beispiel:

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

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

Typen

ExtensionDisabledReason

Chrome (ab Version 44)

Ein Grund für die Deaktivierung des Elements.

Enum

"unbekannt"

"permissions_increase"

ExtensionInfo

Informationen zu einer installierten Erweiterung, App oder einem 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 verfügbar).

  • Beschreibung

    String

    Die Beschreibung dieser Erweiterung, dieser App oder dieses Designs.

  • disabledReason

    ExtensionDisabledReason optional

    Ein Grund für die Deaktivierung des Elements.

  • aktiviert

    boolean

    Gibt an, ob er derzeit aktiviert oder deaktiviert ist.

  • homepageUrl

    String optional

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

  • hostPermissions

    String[]

    Gibt eine Liste hostbasierte Berechtigungen zurück.

  • Symbole

    IconInfo[] optional

    Eine Liste mit Symbolinformationen. Beachten Sie, dass dies lediglich die Angaben im Manifest widerspiegelt. Das tatsächliche Bild unter dieser URL ist möglicherweise größer oder kleiner als angegeben. In diesem Fall können Sie explizite Attribute für Breite und Höhe in 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

    <ph type="x-smartling-placeholder"></ph> 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

    Legt fest, ob diese Erweiterung vom Nutzer deaktiviert oder deinstalliert werden kann.

  • mayEnable

    Boolescher Wert optional

    Chrome 62 und höher

    Legt fest, ob diese Erweiterung vom Nutzer aktiviert werden kann. Dieser Wert wird nur für Erweiterungen zurückgegeben, die nicht aktiviert sind.

  • Name

    String

    Der Name dieser Erweiterung, dieser App oder dieses Designs.

  • offlineEnabled

    boolean

    Ob in der Erweiterung, der App oder dem Design deklariert ist, dass sie den Offlinezugriff unterstützt.

  • optionsUrl

    String

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

  • Berechtigungen

    String[]

    Gibt eine Liste API-basierter Berechtigungen zurück.

  • Kurzname

    String

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

  • Der Typ dieser Erweiterung, dieser App oder dieses Designs.

  • updateUrl

    String optional

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

  • Version

    String

    Die Version dieser Erweiterung, dieser App oder dieses Designs.

  • versionName

    String optional

    Chrome 50 und höher

    Der Versionsname dieser Erweiterung, dieser App oder dieses Designs, wenn im Manifest eines angegeben wurde.

ExtensionInstallType

Chrome (ab Version 44)

Wie die Erweiterung installiert wurde. Eine von 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"

"Entwicklung"

"normal"

"sideload"

"Sonstiges"

ExtensionType

Chrome (ab Version 44)

Der Typ dieser Erweiterung, dieser App oder dieses Designs.

Enum

"Erweiterung"

"hosted_app"

&quot;packaged_app&quot;

&quot;legacy_packaged_app&quot;

"theme"

&quot;login_screen_extension&quot;

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 angibt. Zu den wahrscheinlichen Werten gehören unter anderem 128, 48, 24 und 16.

  • URL

    String

    Die URL für dieses Symbolbild. Wenn das Symbol in Graustufen angezeigt werden soll, z. B. um darauf hinzuweisen, dass eine Erweiterung deaktiviert ist, hängen Sie ?grayscale=true an die URL an.

LaunchType

Das sind alles mögliche App-Starttypen.

Enum

&quot;OPEN_AS_REGULAR_TAB&quot;

&quot;OPEN_AS_PINNED_TAB&quot;

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome (ab Version 88)

Optionen für die Deinstallation der Erweiterung.

Attribute

  • showConfirmDialog

    Boolescher Wert optional

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

Methoden

createAppShortcut()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.createAppShortcut(
  id: string,
  callback?: function,
)

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

Parameter

  • id

    String

    Dies sollte die ID aus einem App-Element von management.ExtensionInfo sein.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
)

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 darf nur "http" sein oder "https".

  • Titel

    String

    Der Titel der generierten App.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (result: ExtensionInfo) => void

Gibt Folgendes zurück:

  • Promise&lt;ExtensionInfo&gt;

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

get()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.get(
  id: string,
  callback?: function,
)

Gibt Informationen über die installierte Erweiterung, App oder das Design mit der angegebenen ID zurück.

Parameter

Gibt Folgendes zurück:

  • Promise&lt;ExtensionInfo&gt;

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

getAll()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.getAll(
  callback?: function,
)

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

Parameter

Gibt Folgendes zurück:

  • Promise&lt;ExtensionInfo[]&gt;

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

getPermissionWarningsById()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
)

Gibt eine Liste mit 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[]

Gibt Folgendes zurück:

  • Promise&lt;string[]&gt;

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

getPermissionWarningsByManifest()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
)

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

Parameter

  • manifestStr

    String

    Manifest-JSON-String der Erweiterung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (permissionWarnings: string[]) => void

    • permissionWarnings

      String[]

Gibt Folgendes zurück:

  • Promise&lt;string[]&gt;

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

getSelf()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.getSelf(
  callback?: function,
)

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

Parameter

Gibt Folgendes zurück:

  • Promise&lt;ExtensionInfo&gt;

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

installReplacementWebApp()

<ph type="x-smartling-placeholder"></ph> Versprechen Chrome 77 oder höher 
chrome.management.installReplacementWebApp(
  callback?: function,
)

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

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

launchApp()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.launchApp(
  id: string,
  callback?: function,
)

Startet eine Anwendung.

Parameter

  • id

    String

    Die Erweiterungs-ID der Anwendung.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setEnabled()

<ph type="x-smartling-placeholder"></ph> 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. bei 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 aus einem Element 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

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setLaunchType()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
  callback?: function,
)

Starttyp einer App festlegen

Parameter

  • id

    String

    Dies sollte die ID aus einem App-Element von management.ExtensionInfo sein.

  • launchType

    LaunchType

    Der gewünschte Starttyp. Dieser Starttyp muss immer in ExtensionInfo.availableLaunchTypes angegeben sein, da die verfügbaren Starttypen je nach Plattform und Konfiguration variieren.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

uninstall()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
)

Deinstalliert eine derzeit installierte App oder Erweiterung. Hinweis: Diese Funktion funktioniert nicht in verwalteten Umgebungen, in denen 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 festgelegtem runtime.lastError aufgerufen.

Parameter

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

uninstallSelf()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
)

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

Parameter

  • Optionen

    UninstallOptions optional

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome (ab Version 88)

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

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