chrome.management

Description

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

Autorisations

management

Fichier manifeste

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

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

management.getPermissionWarningsByManifest, management.uninstallSelf et Les management.getSelf ne nécessitent pas d'autorisation de gestion.

Types

ExtensionDisabledReason

Chrome (version 44 ou ultérieure)

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

Énumération

"inconnu"

"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 pour les applications).

  • availableLaunchTypes

    LaunchType[] facultatif

    Types de lancements actuellement disponibles (uniquement 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

    Indique s'il est actuellement activé ou désactivé.

  • homepageUrl

    chaîne 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 les icônes. Notez que cela ne reflète que ce qui a été déclaré dans le fichier manifeste et que l'image à 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 dans les balises img qui font référence à ces images. Pour en savoir plus, consultez la documentation sur les icônes dans les fichiers manifestes.

  • id

    chaîne

    Identifiant unique de l'extension.

  • installType

    ExtensionInstallType

    La manière dont l'extension a été installée.

  • isApp

    booléen

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

    booléen

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

  • mayEnable

    Booléen facultatif

    Chrome (version 62 ou ultérieure)

    Indique si l'utilisateur peut activer cette extension. Cette valeur est uniquement renvoyée 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 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 une API.

  • Nom court

    chaîne

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

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

  • updateUrl

    chaîne 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

    chaîne facultatif

    Chrome (version 50 ou ultérieure)

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

ExtensionInstallType

Chrome (version 44 ou ultérieure)

La manière dont 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 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 la machine. other: l'extension a été installée par d'autres moyens.

Énumération

"admin"

"développement"

"normal"

"téléchargement indépendant"

"autre"

ExtensionType

Chrome (version 44 ou ultérieure)

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

Énumération

"extension"

"Hosted_app"

&quot;packaged_app&quot;

&quot;legacy_packaged_app&quot;

"theme"

&quot;login_screen_extension&quot;

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

Tous ces types de lancements sont possibles.

Énumération

&quot;OPEN_AS_REGULAR_TAB&quot;

&quot;OPEN_AS_PINNED_TAB&quot;

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome (version 88 ou ultérieure)

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 désinstallations automatiques. 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()

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

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome (version 88 ou ultérieure)

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

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

  • titre

    chaîne

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

  • rappel

    function facultatif

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

    (result: ExtensionInfo) => void

Renvoie

  • Promise&lt;ExtensionInfo&gt;

    Chrome (version 88 ou ultérieure)

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

get()

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

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

Paramètres

Renvoie

  • Promise&lt;ExtensionInfo&gt;

    Chrome (version 88 ou ultérieure)

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

getAll()

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

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

Paramètres

  • rappel

    function facultatif

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

    (result: ExtensionInfo[]) => void

Renvoie

  • Promise&lt;ExtensionInfo[]&gt;

    Chrome (version 88 ou ultérieure)

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

getPermissionWarningsById()

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

    function facultatif

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      chaîne[]

Renvoie

  • Promise&lt;string[]&gt;

    Chrome (version 88 ou ultérieure)

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

getPermissionWarningsByManifest()

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

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

Paramètres

  • manifestStr

    chaîne

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

  • rappel

    function facultatif

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      chaîne[]

Renvoie

  • Promise&lt;string[]&gt;

    Chrome (version 88 ou ultérieure)

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

getSelf()

<ph type="x-smartling-placeholder"></ph> 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 d'autorisation de gestion. dans le fichier manifeste.

Paramètres

  • rappel

    function facultatif

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

    (result: ExtensionInfo) => void

Renvoie

  • Promise&lt;ExtensionInfo&gt;

    Chrome (version 88 ou ultérieure)

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

installReplacementWebApp()

<ph type="x-smartling-placeholder"></ph> Promesse Chrome 77 ou version ultérieure 
chrome.management.installReplacementWebApp(
  callback?: function,
)

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

Paramètres

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome (version 88 ou ultérieure)

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

launchApp()

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

Lance une application.

Paramètres

  • id

    chaîne

    ID d'extension de l'application.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome (version 88 ou ultérieure)

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

setEnabled()

<ph type="x-smartling-placeholder"></ph> 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 cadre 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'identifiant d'un élément de la propriété management.ExtensionInfo.

  • activé

    booléen

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

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome (version 88 ou ultérieure)

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

setLaunchType()

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

  • launchType

    LaunchType

    Type de lancement cible. Assurez-vous toujours que ce type de lancement est défini sur ExtensionInfo.availableLaunchTypes, car les types de lancements disponibles varient selon les plates-formes et les configurations.

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome (version 88 ou ultérieure)

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

uninstall()

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

Désinstallez une application ou une extension déjà 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 refusée ou le rappel est appelé avec runtime.lastError défini.

Paramètres

  • id

    chaîne

    Il doit s'agir de l'identifiant d'un élément de la propriété management.ExtensionInfo.

  • options

    UninstallOptions facultatif

  • rappel

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome (version 88 ou ultérieure)

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

uninstallSelf()

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

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

    function facultatif

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

    () => void

Renvoie

  • Promesse<void>

    Chrome (version 88 ou ultérieure)

    Les promesses ne sont compatibles qu'avec Manifest V3 et 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

  • rappel

    fonction

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

    (id: string) => void

    • id

      chaîne