chrome.types

Description

L'API chrome.types contient des déclarations de type pour Chrome.

Paramètres de Google Chrome

Le type ChromeSetting fournit un ensemble commun de fonctions (get(), set() et clear()) et un éditeur d'événements (onChange) pour les paramètres du navigateur Chrome. Les paramètres du proxy exemples montrent comment ces fonctions sont destinées à être utilisées.

Champ d'application et cycle de vie

Chrome distingue trois champs d'application différents des paramètres du navigateur:

regular
Les paramètres définis dans le champ d'application regular s'appliquent aux fenêtres de navigateur standards et sont hérités par le mode navigation privée les fenêtres, si elles ne sont pas écrasées. Ces paramètres sont stockés sur le disque et restent en place jusqu'à ils sont effacés par l'extension compétente, ou cette extension est désactivée ou désinstallée.
incognito_persistent
Les paramètres définis dans le champ d'application incognito_persistent ne s'appliquent qu'aux fenêtres de navigation privée. Pour ceux-ci, ils remplacer les paramètres regular. Ces paramètres sont stockés sur le disque et restent en place jusqu'à ce qu'ils soient effacée par l'extension compétente, ou que celle-ci est désactivée ou désinstallée.
incognito_session_only
Les paramètres définis dans le champ d'application incognito_session_only ne s'appliquent qu'aux fenêtres de navigation privée. Pour ceux-ci, ils remplacer les paramètres regular et incognito_persistent. Ces paramètres ne sont pas stockés sur le disque et sont effacés lors de la fermeture de la dernière fenêtre de navigation privée. Elles ne peuvent être définies que si au moins un fenêtre de navigation privée est ouverte.

Priorité

Chrome gère les paramètres sur différentes couches. La liste suivante décrit les couches qui peuvent influencent les paramètres en vigueur, par ordre croissant de priorité.

  1. Paramètres système fournis par le système d'exploitation
  2. Paramètres de ligne de commande
  3. Paramètres fournis par les extensions
  4. Règles

Comme indiqué dans la liste, les règles peuvent prévaloir sur toute modification spécifiée dans votre extension. Toi Vous pouvez utiliser la fonction get() pour déterminer si votre extension est capable de fournir un paramètre. ou si ce paramètre serait ignoré.

Comme indiqué précédemment, Chrome permet d'utiliser des paramètres différents pour les fenêtres standards et la navigation privée. Windows. L'exemple suivant illustre ce comportement. Supposons qu'aucune règle ne remplace et qu'une extension peut définir les paramètres des fenêtres standards (R) et les paramètres des fenêtres de navigation privée (I).

  • Si seul (R) est défini, ces paramètres s'appliquent à la fois aux fenêtres standards et aux fenêtres de navigation privée.
  • Si seul (I) est défini, ces paramètres ne s'appliquent qu'aux fenêtres de navigation privée. Fenêtres standards utiliser les paramètres déterminés par les couches inférieures (options de ligne de commande et paramètres système) ;
  • Si les paramètres (R) et (I) sont tous les deux définis, les paramètres respectifs sont utilisés pour la navigation standard et la navigation privée. Windows.

Si deux extensions ou plus souhaitent définir le même paramètre sur des valeurs différentes, elles sont installées prévaut sur les autres extensions. Si la dernière extension installée est défini sur (I), les paramètres des fenêtres standards peuvent être définis par des données .

La valeur effective d'un paramètre est celle résultant de la prise en compte des règles de priorité. Il est utilisé par Chrome.

Types

ChromeSetting

Interface qui permet d'accéder à un paramètre du navigateur Chrome. Consultez la section accessibilityFeatures pour obtenir un exemple.

Propriétés

  • onChange

    Événement<functionvoid>

    Déclenché après la modification du paramètre.

    La fonction onChange.addListener se présente comme suit: 

    (callback: function) => {...}

    • rappel

      fonction

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

      (details: object) => void

      • détails

        objet

        • incognitoSpecific

          Booléen facultatif

          Indique si la valeur modifiée est spécifique à la session de navigation privée. Cette propriété sera présente uniquement si l'utilisateur a activé l'extension en mode navigation privée.

        • levelOfControl

          LevelOfControl

          Niveau de contrôle du paramètre.

        • valeur

          T

          Valeur du paramètre après la modification.

  • effacer

    vide

    <ph type="x-smartling-placeholder"></ph> Promesse

    Efface le paramètre et restaure toute valeur par défaut.

    La fonction clear se présente comme suit: 

    (details: object, callback?: function) => {...}

    • détails

      objet

      Paramètre à effacer.

      • champ d'application

        ChromeSettingScope facultatif

        Permet d'effacer le paramètre (par défaut: normal).

    • rappel

      function facultatif

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

      () => void

    • retours

      Promesse<void>

      Chrome 96 ou version ultérieure

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

  • get

    vide

    <ph type="x-smartling-placeholder"></ph> Promesse

    Récupère la valeur d'un paramètre.

    La fonction get se présente comme suit: 

    (details: object, callback?: function) => {...}

    • détails

      objet

      Paramètre à prendre en compte.

      • navigation privée

        Booléen facultatif

        Indique si la valeur qui s'applique à la session de navigation privée doit être renvoyée (valeur par défaut "false").

    • rappel

      function facultatif

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

      (details: object) => void

      • détails

        objet

        Détails de la valeur actuellement effective.

        • incognitoSpecific

          Booléen facultatif

          Indique si la valeur effective est spécifique à la session de navigation privée. Cette propriété sera présente uniquement si la propriété incognito dans le paramètre details de get() était "true".

        • levelOfControl

          LevelOfControl

          Niveau de contrôle du paramètre.

        • valeur

          T

          Valeur du paramètre.

    • retours

      Promise&lt;object&gt;

      Chrome 96 ou version ultérieure

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

  • set

    vide

    <ph type="x-smartling-placeholder"></ph> Promesse

    Définit la valeur d'un paramètre.

    La fonction set se présente comme suit: 

    (details: object, callback?: function) => {...}

    • détails

      objet

      Paramètre à modifier.

      • champ d'application

        ChromeSettingScope facultatif

        Où définir le paramètre (par défaut: normal).

      • valeur

        T

        Valeur du paramètre. Notez que chaque paramètre possède un type de valeur spécifique, qui est décrit avec le paramètre. Une extension ne doit pas définir une valeur d'un type différent.

    • rappel

      function facultatif

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

      () => void

    • retours

      Promesse<void>

      Chrome 96 ou version ultérieure

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

ChromeSettingScope

Chrome 44 ou version ultérieure

Champ d'application de ChromeSetting. Une

  • regular: paramètre du profil standard (qui est hérité par le profil de navigation privée s'il n'est pas remplacé ailleurs).
  • regular\_only: paramètre pour le profil standard uniquement (non hérité par le profil de navigation privée).
  • incognito\_persistent: paramètre du profil de navigation privée qui reste après un redémarrage du navigateur (remplace les préférences standards).
  • incognito\_session\_only: paramètre du profil de navigation privée qui ne peut être défini que lors d'une session de navigation privée et qui est supprimé à la fin de celle-ci (remplace les préférences standards et incognito_persistent).

Énumération

"standard"

"regular_only"

"incognito_persistent"

"incognito_session_only"

LevelOfControl

Chrome 44 ou version ultérieure

Une

  • not\_controllable: ne peut être contrôlé par aucune extension.
  • controlled\_by\_other\_extensions: contrôlé par des extensions ayant une priorité plus élevée
  • controllable\_by\_this\_extension: peut être contrôlé par cette extension.
  • controlled\_by\_this\_extension: contrôlé par cette extension

Énumération

"not_controllable"

&quot;controlled_by_other_extensions&quot;

&quot;controllable_by_this_extension&quot;

&quot;controlled_by_this_extension&quot;