chrome.types

Beschreibung

Die chrome.types API enthält Typdeklarationen für Chrome.

Chrome-Einstellungen

Der Typ ChromeSetting bietet einen gemeinsamen Satz von Funktionen (get(), set() und clear()). sowie einen Ereignis-Publisher (onChange) für die Einstellungen des Chrome-Browsers. Die Proxy-Einstellungen Beispiele zeigen, wie diese Funktionen verwendet werden.

Umfang und Lebenszyklus

Chrome unterscheidet zwischen drei verschiedenen Bereichen der Browsereinstellungen:

regular
Im Bereich regular festgelegte Einstellungen gelten für normale Browserfenster und werden vom Inkognitomodus übernommen wenn diese nicht überschrieben werden. Diese Einstellungen werden auf dem Laufwerk gespeichert, bis Sie werden von der zuständigen Erweiterung freigegeben oder die zugehörige Erweiterung wird deaktiviert oder deinstalliert.
incognito_persistent
Im Bereich incognito_persistent festgelegte Einstellungen gelten nur für Inkognitofenster. Bei diesen regular-Einstellungen überschreiben. Diese Einstellungen werden auf dem Laufwerk gespeichert, bis sie von der zuständigen Erweiterung freigegeben wurde oder die betreffende Erweiterung deaktiviert oder deinstalliert wurde.
incognito_session_only
Im Bereich incognito_session_only festgelegte Einstellungen gelten nur für Inkognitofenster. Bei diesen regular- und incognito_persistent-Einstellungen überschreiben. Diese Einstellungen werden nicht auf dem Laufwerk gespeichert und werden gelöscht, wenn das letzte Inkognitofenster geschlossen wird. Sie können nur festgelegt werden, wenn mindestens eine Inkognitofenster geöffnet ist.

Vorrang

Chrome verwaltet Einstellungen auf verschiedenen Ebenen. In der folgenden Liste werden die Ebenen beschrieben, die möglicherweise Einfluss auf die geltenden Einstellungen haben, in aufsteigender Reihenfolge.

  1. Vom Betriebssystem bereitgestellte Systemeinstellungen
  2. Befehlszeilenparameter
  3. Von Erweiterungen bereitgestellte Einstellungen
  4. Richtlinien

Wie aus der Liste hervorgeht, können Richtlinien alle Änderungen, die Sie in der Erweiterung vornehmen, außer Kraft setzen. Ich kann mithilfe der Funktion „get()“ feststellen, ob deine Erweiterung eine Einstellung bereitstellen kann oder ob diese Einstellung überschrieben wird.

Wie bereits erwähnt, können in Chrome verschiedene Einstellungen für normale Fenster und den Inkognitomodus verwendet werden Fenster. Das folgende Beispiel veranschaulicht das Verhalten. Davon ausgehen, dass keine Richtlinie die und dass eine Erweiterung Einstellungen für normale Fenster (R) und Einstellungen für Inkognitofenstern (I).

  • Wenn nur (R) festgelegt ist, gelten diese Einstellungen sowohl für normale als auch für Inkognitofenster.
  • Ist nur (I) festgelegt, gelten diese Einstellungen nur für Inkognitofenster. Normale Fenster Verwenden Sie die Einstellungen, die von den niedrigeren Ebenen (Befehlszeilenoptionen und Systemeinstellungen) festgelegt werden.
  • Wenn sowohl (R) als auch (I) festgelegt sind, werden die entsprechenden Einstellungen für den regulären und den Inkognitomodus verwendet. Fenster.

Wenn für zwei oder mehr Erweiterungen für dieselbe Einstellung unterschiedliche Werte festgelegt werden sollen, wurde die Erweiterung installiert hat Vorrang vor den anderen Erweiterungen. Wenn die zuletzt installierte Erweiterung nur (I) festlegt, können die Einstellungen normaler Fenster durch zuvor installierte Fenster Erweiterungen.

Der effektive Wert einer Einstellung ergibt sich aus den Prioritätsregeln. Es von Chrome verwendet wird.

Typen

ChromeSetting

Eine Oberfläche, die den Zugriff auf eine Chrome-Browsereinstellung ermöglicht. Ein Beispiel findest du unter accessibilityFeatures.

Attribute

  • onChange

    Ereignis<functionvoidvoid>

    Wird ausgelöst, nachdem die Einstellung geändert wurde.

    Die Funktion onChange.addListener sieht so aus:

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

    • callback

      Funktion

      Der Parameter callback sieht so aus:

      (details: object) => void

      • Details

        Objekt

        • incognitoSpecific

          Boolescher Wert optional

          Gibt an, ob der geänderte Wert für die Inkognitositzung spezifisch ist. Diese Eigenschaft ist nur vorhanden, wenn der Nutzer die Erweiterung im Inkognitomodus aktiviert hat.

        • levelOfControl

          Der Grad der Kontrolle über die Einstellung.

        • Wert

          T

          Der Wert der Einstellung nach der Änderung.

  • löschen

    voidm

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

    Löscht die Einstellung und stellt alle Standardwerte wieder her.

    Die Funktion clear sieht so aus:

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

    • Details

      Objekt

      Welche Einstellung gelöscht werden soll.

      • Bereich

        Ort, an dem die Einstellung gelöscht werden soll (Standardeinstellung: Normal)

    • callback

      Funktion optional

      Der Parameter callback sieht so aus:

      () => void

    • Gibt zurück

      Versprechen<void>

      Chrome 96 und höher

      Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

  • get

    voidm

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

    Ruft den Wert einer Einstellung ab.

    Die Funktion get sieht so aus:

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

    • Details

      Objekt

      Welche Einstellung Sie berücksichtigen sollten

      • Inkognito

        Boolescher Wert optional

        Gibt an, ob der Wert zurückgegeben werden soll, der für die Inkognitositzung gilt (Standardeinstellung: false).

    • callback

      Funktion optional

      Der Parameter callback sieht so aus:

      (details: object) => void

      • Details

        Objekt

        Details zum aktuell gültigen Wert.

        • incognitoSpecific

          Boolescher Wert optional

          Gibt an, ob der effektive Wert für die Inkognitositzung spezifisch ist. Diese Eigenschaft ist nur vorhanden, wenn die Eigenschaft incognito im Parameter details von get() wahr war.

        • levelOfControl

          Der Grad der Kontrolle über die Einstellung.

        • Wert

          T

          Der Wert der Einstellung.

    • Gibt zurück

      Promise&lt;object&gt;

      Chrome 96 und höher

      Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

  • set

    voidm

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

    Legt den Wert einer Einstellung fest.

    Die Funktion set sieht so aus:

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

    • Details

      Objekt

      Einstellung, die geändert werden soll.

      • Bereich

        Einstellung, wo die Einstellung festgelegt werden soll (Standardeinstellung: Normal)

      • Wert

        T

        Der Wert der Einstellung. Beachten Sie, dass jede Einstellung einen bestimmten Werttyp hat, der zusammen mit der Einstellung beschrieben wird. Über eine Erweiterung sollte kein Wert eines anderen Typs festgelegt werden.

    • callback

      Funktion optional

      Der Parameter callback sieht so aus:

      () => void

    • Gibt zurück

      Versprechen<void>

      Chrome 96 und höher

      Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

ChromeSettingScope

Chrome (ab Version 44)

Der Bereich der ChromeSetting. Eine von

  • regular: Einstellung für das reguläre Profil (die vom Inkognitoprofil übernommen wird, wenn sie nicht an anderer Stelle überschrieben wird)
  • regular\_only: Einstellung nur für das reguläre Profil (nicht vom Inkognitoprofil übernommen),
  • incognito\_persistent: Einstellung für das Inkognitoprofil, das auch nach Browserneustarts gilt (normale Einstellungen werden überschrieben)
  • incognito\_session\_only: Einstellung für das Inkognitoprofil, das nur während einer Inkognitositzung festgelegt werden kann und am Ende der Inkognitositzung gelöscht wird. Dadurch werden die regulären und die Inkognito-persistenten Einstellungen überschrieben.

Enum

"Normal"

"regular_only"

"Inkognito_persistent"

"Inkognito_session_only"

LevelOfControl

Chrome (ab Version 44)

Eine von

  • not\_controllable: kann von keiner Erweiterung gesteuert werden
  • controlled\_by\_other\_extensions: von Erweiterungen mit höherer Priorität gesteuert
  • controllable\_by\_this\_extension: kann von dieser Erweiterung gesteuert werden
  • controlled\_by\_this\_extension: von dieser Erweiterung gesteuert

Enum

"not_controllable"

&quot;controlled_by_other_extensions&quot;

&quot;controllable_by_this_extension&quot;

&quot;controlled_by_this_extension&quot;