chrome.management

Description

L'API chrome.management permet de gérer la liste des extensions/applications installées et en cours d'exécution. Elle est particulièrement utile pour les extensions qui remplacent la page "Nouvel onglet" intégrée.

Autorisations

management

Pour utiliser l'API de gestion, vous devez déclarer l'autorisation de "gestion" dans le fichier manifeste de l'extension. 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 ou version ultérieure

Motif de désactivation de l'élément.

Enum

"unknown"

ExtensionInfo

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

Propriétés

  • appLaunchUrl

    string facultatif

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

  • availableLaunchTypes

    LaunchType[] facultatif

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

  • description

    chaîne

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

  • disabledReason

    ExtensionDisabledReason facultatif

    Motif de désactivation de l'élément.

  • activé

    boolean

    Indique si elle est actuellement activée ou désactivée.

  • homepageUrl

    string facultatif

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

  • hostPermissions

    chaîne[]

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

  • icônes

    IconInfo[] facultatif

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

  • id

    chaîne

    Identifiant unique de l'extension.

  • installType

    ExtensionInstallType

    Façon dont l'extension a été installée.

  • isApp

    boolean

    Obsolète

    Veuillez utiliser management.ExtensionInfo.type.

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

  • launchType

    LaunchType facultatif

    Type de lancement de l'application (disponible uniquement pour les applications).

  • mayDisable

    boolean

    Indique si l'extension peut être désactivée ou désinstallée par l'utilisateur.

  • mayEnable

    Booléen facultatif

    Chrome 62 ou version ultérieure

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

  • name

    chaîne

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

  • offlineEnabled

    boolean

    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'article, le cas échéant.

  • autorisations

    chaîne[]

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

  • shortName

    chaîne

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

  • Type d'extension, d'application ou de thème.

  • updateUrl

    string facultatif

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

  • version

    chaîne

    Version de cette extension, de cette application ou de ce thème

  • versionName

    string facultatif

    Chrome 50 et versions ultérieures

    Nom de la version de cette extension, de cette application ou de ce thème, si le fichier manifeste en spécifie une.

ExtensionInstallType

Chrome 44 ou version ultérieure

Façon dont l'extension a été installée. L'une des 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 la machine, other

Enum

"admin"

"development"

"normal"

ExtensionType

Chrome 44 ou version ultérieure

Type d'extension, d'application ou de thème.

Enum

"extension"

"packaged_app"

"legacy_packaged_app"

"login_screen_extension"

IconInfo

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

Propriétés

  • taille

    number

    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 de l'icône en nuances de gris (pour indiquer qu'une extension est désactivée, par exemple), ajoutez ?grayscale=true à l'URL.

LaunchType

Ce sont tous les types de lancements d’applications possibles.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88 et versions ultérieures

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

Propriétés

  • showConfirmDialog

    Booléen facultatif

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

Méthodes

createAppShortcut()

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

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

Paramètres

  • id

    chaîne

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

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

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

Générez 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".

  • title

    chaîne

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

  • rappel

    fonction facultative

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

    (result: ExtensionInfo)=>void

Renvoie

  • Promise<ExtensionInfo>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

get()

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

Affiche des informations sur l'extension, l'application ou le thème installé et associés à l'ID indiqué.

Paramètres

Renvoie

  • Promise<ExtensionInfo>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getAll()

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

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

Paramètres

  • rappel

    fonction facultative

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

    (result: ExtensionInfo[])=>void

Renvoie

  • Promise<ExtensionInfo[]>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getPermissionWarningsById()

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

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.

  • rappel

    fonction facultative

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

    (permissionWarnings: string[])=>void

    • permissionWarnings

      chaîne[]

Renvoie

  • Promesse<string[]>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getPermissionWarningsByManifest()

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

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

Paramètres

  • manifestStr

    chaîne

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

  • rappel

    fonction facultative

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

    (permissionWarnings: string[])=>void

    • permissionWarnings

      chaîne[]

Renvoie

  • Promesse<string[]>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getSelf()

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

Affiche des informations sur l'extension d'appel, l'application ou le thème. Remarque: Cette fonction peut être utilisée sans demander l'autorisation de gestion dans le fichier manifeste.

Paramètres

  • rappel

    fonction facultative

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

    (result: ExtensionInfo)=>void

Renvoie

  • Promise<ExtensionInfo>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

installReplacementWebApp()

Promesse Chrome 77 et versions ultérieures 
chrome.management.installReplacementWebApp(
  callback?: function,
)

Lance l'application replace_web_app spécifiée dans le fichier manifeste. Invite l'utilisateur à effectuer l'installation s'il n'est pas déjà installé.

Paramètres

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

launchApp()

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

Lance une application.

Paramètres

  • id

    chaîne

    ID d'extension de l'application.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setEnabled()

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

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 interface utilisateur de confirmation native afin d'éviter toute utilisation abusive.

Paramètres

  • id

    chaîne

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

  • activé

    boolean

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

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setLaunchType()

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

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

Paramètres

  • id

    chaîne

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

  • launchType

    LaunchType

    Type de lancement cible. Vérifiez toujours que ce type de lancement est inclus dans ExtensionInfo.availableLaunchTypes, car les types de lancements disponibles varient selon les plates-formes et les configurations.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

uninstall()

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

Désinstallez 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 est rejetée ou le rappel est appelé avec runtime.lastError défini.

Paramètres

  • id

    chaîne

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

  • options

    UninstallOptions facultatif

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

uninstallSelf()

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

Désinstallez l'extension d'appel. Remarque: Cette fonction peut être utilisée sans demander l'autorisation de gestion 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

  • options

    UninstallOptions facultatif

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

Événements

onDisabled

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

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

Paramètres

onEnabled

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

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

Paramètres

onInstalled

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

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

Paramètres

onUninstalled

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

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

Paramètres

  • rappel

    function

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

    (id: string)=>void

    • id

      chaîne