browser.management

Description

L'API chrome.management permet de gérer les applications et les extensions installées.

Autorisations

management

Vous devez déclarer l'autorisation "management" dans le fichier manifeste de l'extension pour utiliser l'API Management. Exemple :

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

management.getPermissionWarningsByManifest(), management.uninstallSelf() et management.getSelf() ne nécessitent pas l'autorisation de gestion.

Types

ExtensionDisabledReason

Chrome 44+ browser.* depuis Chrome 148

Raison pour laquelle l'élément est désactivé.

Énumération

"unknown"

"permissions_increase"

ExtensionInfo

Informations sur une extension, une application ou un thème installés.

Propriétés

  • appLaunchUrl

    chaîne facultatif

    URL de lancement (uniquement présente pour les applications).

  • availableLaunchTypes

    LaunchType[] facultatif

    Types de lancement actuellement disponibles (uniquement présents pour les applications).

  • description

    chaîne

    Description de l'extension, de l'application ou du thème.

  • disabledReason

    ExtensionDisabledReason facultatif

    Raison pour laquelle l'élément est désactivé.

  • activé

    booléen

    S'il est actuellement activé ou désactivé.

  • homepageUrl

    chaîne facultatif

    URL de la page d'accueil de cette extension, application ou thème.

  • hostPermissions

    chaîne[]

    Renvoie une liste d'autorisations basées sur l'hôte.

  • icônes

    IconInfo[] facultatif

    Liste d'informations sur les icônes. Notez que cela reflète simplement ce qui a été déclaré dans le fichier manifeste. L'image réelle à cette URL peut être plus grande ou plus petite que ce qui a été déclaré. Vous pouvez donc envisager d'utiliser des attributs de largeur et de hauteur explicites sur les balises img faisant référence à ces images. Pour en savoir plus, consultez la documentation sur les icônes dans le fichier manifeste.

  • id

    chaîne

    Identifiant unique de l'extension.

  • installType

    ExtensionInstallType

    Indique comment l'extension a été installée.

  • isApp

    booléen

    Obsolète

    Veuillez utiliser management.ExtensionInfo.type.

    "True" s'il s'agit d'une application.

  • launchType

    LaunchType facultatif

    Type de lancement de l'application (uniquement présent pour les applications).

  • mayDisable

    booléen

    Indique si l'utilisateur peut désactiver ou désinstaller cette extension.

  • mayEnable

    boolean facultatif

    Chrome 62 ou version ultérieure browser.* depuis Chrome 148

    Indique si l'utilisateur peut activer cette extension. Cette valeur n'est renvoyée que pour les extensions qui ne sont pas activées.

  • nom

    chaîne

    Nom de l'extension, de l'application ou du thème.

  • offlineEnabled

    booléen

    Indique si l'extension, l'application ou le thème déclare être compatible avec le mode hors connexion.

  • optionsUrl

    chaîne

    URL de la page d'options de l'élément, s'il en existe une.

  • autorisations

    chaîne[]

    Renvoie une liste d'autorisations basées sur l'API.

  • shortName

    chaîne

    Version courte du nom de cette extension, application ou thème.

  • Type de cette extension, application ou thème.

  • updateUrl

    chaîne facultatif

    URL de mise à jour de cette extension, application ou thème.

  • version

    chaîne

    La version de cette extension, application ou thème.

  • versionName

    chaîne facultatif

    Chrome 50 ou version ultérieure browser.* depuis Chrome 148

    Le nom de la version de cette extension, application ou thème, si le fichier manifeste en a spécifié un.

ExtensionInstallType

Chrome 44+ browser.* depuis Chrome 148

Indique comment l'extension a été installée. L'une des valeurs suivantes : admin : l'extension a été installée en raison d'une règle d'administration. development : l'extension a été chargée non empaquetée en mode développeur. normal : l'extension a été installée normalement via un fichier .crx. sideload : l'extension a été installée par un autre logiciel sur l'ordinateur. other : l'extension a été installée par d'autres moyens.

Énumération

"admin"

"development"

"normal"

"sideload"

"other"

ExtensionType

Chrome 44+ browser.* depuis Chrome 148

Type de cette extension, application ou thème.

Énumération

"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

Informations sur une icône appartenant à une extension, une application ou un thème.

Propriétés

  • taille

    nombre

    Nombre représentant la largeur et la hauteur de l'icône. Les valeurs probables incluent (sans s'y limiter) 128, 48, 24 et 16.

  • url

    chaîne

    URL de cette image d'icône. Pour afficher une version en nuances de gris de l'icône (pour indiquer qu'une extension est désactivée, par exemple), ajoutez ?grayscale=true à l'URL.

LaunchType

Voici tous les types de lancement d'application possibles.

Énumération

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88+ browser.* depuis Chrome 148

Options de gestion de la désinstallation de l'extension.

Propriétés

  • showConfirmDialog

    boolean facultatif

    Indique si une boîte de dialogue de confirmation de désinstallation doit s'afficher. La valeur par défaut est "false" pour les auto-désinstallations. Si une extension en désinstalle une autre, ce paramètre est ignoré et la boîte de dialogue s'affiche toujours.

Méthodes

createAppShortcut()

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

Affiche les options permettant de créer des raccourcis pour une application. Sur Mac, seuls les raccourcis d'applications empaquetées peuvent être créés.

Paramètres

Renvoie

  • Promise<void>

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

Générer une application pour une URL. Renvoie l'application de favori générée.

Paramètres

  • url

    chaîne

    URL d'une page Web. Le schéma de l'URL ne peut être que "http" ou "https".

  • titre

    chaîne

    Titre de l'application générée.

Renvoie

  • Promise<ExtensionInfo>

    Chrome 88+ browser.* depuis Chrome 148

get()

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

Renvoie des informations sur l'extension, l'application ou le thème installé qui possède l'ID indiqué.

Paramètres

Renvoie

  • Promise<ExtensionInfo>

    Chrome 88+ browser.* depuis Chrome 148

getAll()

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

Renvoie une liste d'informations sur les extensions et les applications installées.

Renvoie

  • thought Promise<ExtensionInfo[]>

    Chrome 88+ browser.* depuis Chrome 148

getPermissionWarningsById()

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

Renvoie une liste d'avertissements d'autorisation pour l'ID d'extension donné.

Paramètres

  • id

    chaîne

    ID d'une extension déjà installée.

Renvoie

  • Promise<string[]>

    Chrome 88+ browser.* depuis Chrome 148

getPermissionWarningsByManifest()

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

Renvoie une liste d'avertissements d'autorisation pour la chaîne de fichier manifeste d'extension donnée. Remarque : Cette fonction peut être utilisée sans demander l'autorisation "management" dans le fichier manifeste.

Paramètres

  • manifestStr

    chaîne

    Chaîne JSON du fichier manifeste de l'extension.

Renvoie

  • Promise<string[]>

    Chrome 88+ browser.* depuis Chrome 148

getSelf()

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

Renvoie des informations sur l'extension, l'application ou le thème appelant. Remarque : Cette fonction peut être utilisée sans demander l'autorisation "management" dans le fichier manifeste.

Renvoie

  • Promise<ExtensionInfo>

    Chrome 88+ browser.* depuis Chrome 148

installReplacementWebApp()

Navigateur Chrome 77+ * depuis Chrome 148 
browser.management.installReplacementWebApp(): Promise<void>

Lance l'application replacement_web_app spécifiée dans le fichier manifeste. Invite l'utilisateur à l'installer si ce n'est pas déjà fait.

Renvoie

  • Promise<void>

    Chrome 88+ browser.* depuis Chrome 148

launchApp()

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

Lance une application.

Paramètres

  • id

    chaîne

    ID d'extension de l'application.

Renvoie

  • Promise<void>

    Chrome 88+ browser.* depuis Chrome 148

setEnabled()

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

Active ou désactive une application ou une extension. Dans la plupart des cas, cette fonction doit être appelée dans le contexte d'un geste de l'utilisateur (par exemple, un gestionnaire onclick pour un bouton) et peut présenter à l'utilisateur une UI de confirmation native afin d'éviter les abus.

Paramètres

  • id

    chaîne

    Il doit s'agir de l'ID d'un élément de management.ExtensionInfo.

  • activé

    booléen

    Indique si cet élément doit être activé ou désactivé.

Renvoie

  • Promise<void>

    Chrome 88+ browser.* depuis Chrome 148

setLaunchType()

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

Définissez le type de lancement d'une application.

Paramètres

Renvoie

  • Promise<void>

    Chrome 88+ browser.* depuis Chrome 148

uninstall()

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

Désinstalle une application ou une extension actuellement installée. Remarque : Cette fonction ne fonctionne pas dans les environnements gérés lorsque l'utilisateur n'est pas autorisé à désinstaller l'extension ou l'application spécifiée. Si la désinstallation échoue (par exemple, si l'utilisateur annule la boîte de dialogue), la promesse sera rejetée ou le rappel sera appelé avec runtime.lastError défini.

Paramètres

Renvoie

  • Promise<void>

    Chrome 88+ browser.* depuis Chrome 148

uninstallSelf()

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

Désinstalle l'extension d'appel. Remarque : Cette fonction peut être utilisée sans demander l'autorisation "management" dans le fichier manifeste. Cette fonction ne fonctionne pas dans les environnements gérés lorsque l'utilisateur n'est pas autorisé à désinstaller l'extension ou l'application spécifiée.

Paramètres

Renvoie

  • Promise<void>

    Chrome 88+ browser.* depuis Chrome 148

Événements

onDisabled

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

Déclenché lorsqu'une application ou une extension a été désactivée.

Paramètres

onEnabled

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

Déclenché lorsqu'une application ou une extension a été activée.

Paramètres

onInstalled

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

Déclenché lorsqu'une application ou une extension a été installée.

Paramètres

onUninstalled

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

Déclenché lorsqu'une application ou une extension a été désinstallée.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

    (id: string) => void

    • id

      chaîne