chrome.management

Description

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

Autorisations

management

Fichier manifeste

Pour utiliser l'API management, vous devez déclarer l'autorisation "management" 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 et versions ultérieures

Raison pour laquelle l'article 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 facultative

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

  • availableLaunchTypes

    LaunchType[] facultatif

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

  • description

    chaîne

    Description de cette extension, application ou de ce thème.

  • disabledReason

    ExtensionDisabledReason facultatif

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

  • activé

    booléen

    Indique si le compte est actuellement activé ou désactivé.

  • homepageUrl

    chaîne facultative

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

  • hostPermissions

    chaîne[]

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

  • icônes

    IconInfo[] facultatif

    Liste d'informations sur les icônes. Notez que cela ne reflète que 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

    La façon dont 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

    booléen facultatif

    Chrome 62 et versions ultérieures

    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 cette extension, application ou de ce 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'article, le cas échéant.

  • autorisations

    chaîne[]

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

  • shortName

    chaîne

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

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

  • updateUrl

    chaîne facultative

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

  • version

    chaîne

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

  • versionName

    chaîne facultative

    Chrome 50 et versions ultérieures

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

ExtensionInstallType

Chrome 44 et versions ultérieures

La façon dont l'extension a été installée. admin : l'extension a été installée en raison d'une règle administrative. development : l'extension a été chargée décompressé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 et versions ultérieures

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

    Total

    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 niveaux 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 et versions ultérieures

Options permettant de gérer la désinstallation de l'extension.

Propriétés

  • showConfirmDialog

    booléen facultatif

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

Méthodes

createAppShortcut()

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

Affiche les options permettant de créer des raccourcis pour une application. Sur Mac, seuls les raccourcis d'applications packagé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.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

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

Générez une application pour une URL. Renvoie l'application de signets 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.

  • callback

    function facultatif

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

    (result: ExtensionInfo) => void

Renvoie

  • Promise<ExtensionInfo>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

get()

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

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

Paramètres

Renvoie

  • Promise<ExtensionInfo>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getAll()

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

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

Paramètres

  • callback

    function facultatif

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

    (result: ExtensionInfo[]) => void

Renvoie

  • Promise<ExtensionInfo[]>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getPermissionWarningsById()

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

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

Paramètres

  • id

    chaîne

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

  • callback

    function facultatif

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      chaîne[]

Renvoie

  • Promise<string[]>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getPermissionWarningsByManifest()

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

Renvoie une liste d'avertissements concernant les autorisations 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.

  • callback

    function facultatif

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      chaîne[]

Renvoie

  • Promise<string[]>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getSelf()

Promise 
chrome.management.getSelf(
  callback?: function,
): 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.

Paramètres

  • callback

    function facultatif

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

    (result: ExtensionInfo) => void

Renvoie

  • Promise<ExtensionInfo>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

installReplacementWebApp()

Promise Chrome 77 et versions ultérieures 
chrome.management.installReplacementWebApp(
  callback?: function,
): Promise<void>

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

Paramètres

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

launchApp()

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

Lance une application.

Paramètres

  • id

    chaîne

    ID d'extension de l'application.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setEnabled()

Promise 
chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
): 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 utilisations abusives.

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

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setLaunchType()

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

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 se trouve dans ExtensionInfo.availableLaunchTypes, car les types de lancement disponibles varient selon les plates-formes et les configurations.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

uninstall()

Promise 
chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
): 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

  • id

    chaîne

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

  • options

    UninstallOptions facultatif

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

uninstallSelf()

Promise 
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
): 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

  • options

    UninstallOptions facultatif

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 88 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

É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

  • callback

    fonction

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

    (id: string) => void

    • id

      chaîne