chrome.types

Açıklama

chrome.types API, Chrome için tür bildirimleri içerir.

Chrome ayarları

ChromeSetting türü, Chrome tarayıcının ayarları için bir etkinlik yayıncısının (onChange) yanı sıra ortak bir işlev grubu (get(), set() ve clear()) sağlar. Proxy ayarı örnekleri, bu işlevlerin nasıl kullanılacağını gösterir.

Kapsam ve yaşam döngüsü

Chrome, üç farklı tarayıcı ayarı kapsamını birbirinden ayırt eder:

regular
regular kapsamında ayarlanan ayarlar normal tarayıcı pencerelerine uygulanır ve üzerine yazılmadığı takdirde gizli pencereler tarafından devralınır. Bu ayarlar diskte depolanır ve geçerli uzantı tarafından temizlenene veya geçerli uzantı devre dışı bırakılana ya da yüklemesi kaldırılana kadar yerinde kalır.
incognito_persistent
incognito_persistent kapsamında yapılan ayarlar yalnızca gizli pencerelerde geçerlidir. Bunlar için regular ayarlarını geçersiz kılarlar. Bu ayarlar diskte depolanır ve geçerli uzantı tarafından temizlenene veya geçerli uzantı devre dışı bırakılana ya da kaldırılana kadar yerinde kalır.
incognito_session_only
incognito_session_only kapsamında yapılan ayarlar yalnızca gizli pencerelerde geçerlidir. Bunlar için regular ve incognito_persistent ayarlarını geçersiz kılarlar. Bu ayarlar diskte depolanmaz ve son gizli pencere kapatıldığında silinir. Bunlar yalnızca en az bir gizli pencere açıkken ayarlanabilir.

Öncelik

Chrome, ayarları farklı katmanlarda yönetir. Aşağıdaki listede, etkili ayarları etkileyebilecek katmanlar, öncelik sırasına göre düzenlenmiş olarak açıklanmaktadır.

  1. İşletim sistemi tarafından sağlanan sistem ayarları
  2. Komut satırı parametreleri
  3. Uzantılar tarafından sağlanan ayarlar
  4. Politikalar

Listenin de gösterdiği gibi, politikalar uzantınızla birlikte belirttiğiniz tüm değişiklikleri geçersiz kılabilir. Uzantınızın bir ayar sağlayıp sağlayamayacağını veya bu ayarın geçersiz kılınıp kılınmayacağını belirlemek için get() işlevini kullanabilirsiniz.

Daha önce belirtildiği gibi Chrome, normal pencereler ve gizli pencereler için farklı ayarların kullanılmasına izin verir. Aşağıdaki örnekte bu davranış gösterilmektedir. Hiçbir politikanın ayarları geçersiz kılmadığını ve bir uzantının normal pencereler (R) ve gizli pencere ayarları (I) için ayarları yapabildiğini varsayalım.

  • Yalnızca (R) ayarlanırsa bu ayarlar hem normal hem de gizli pencereler için geçerli olur.
  • Yalnızca (I) ayarlanırsa bu ayarlar sadece gizli pencereler için geçerli olur. Normal pencereler, alt katmanlar tarafından belirlenen ayarları kullanır (komut satırı seçenekleri ve sistem ayarları).
  • Hem (R) hem de (I) ayarlanırsa normal ve gizli pencereler için ilgili ayarlar kullanılır.

İki veya daha fazla uzantı aynı ayarı farklı değerlere ayarlamak isterse en son yüklenen uzantı diğer uzantılara göre öncelikli olur. En son yüklenen uzantı yalnızca (I) değerini ayarlıyorsa normal pencerelerin ayarları daha önce yüklenen uzantılar tarafından tanımlanabilir.

Bir ayarın effective değeri, öncelik kurallarının dikkate alınmasıyla elde edilen değerdir. Chrome tarafından kullanılır.

Türler

ChromeSetting

Chrome tarayıcı ayarına erişim sağlayan arayüz. Örnek için bkz. accessibilityFeatures.

Özellikler

  • onChange

    Etkinlik<functionvoidvoid>

    Ayar değiştikten sonra tetiklenir.

    onChange.addListener işlevi şu şekilde görünür:

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

    • geri çağırma

      işlev

      callback parametresi şu şekilde görünür:

      (details: object)=>void

      • ayrıntılar

        nesne

        • incognitoSpecific

          boole isteğe bağlı

          Değişen değerin gizli oturuma özel olup olmadığı. Bu özellik yalnızca kullanıcı, uzantıyı gizli modda etkinleştirdiyse gösterilir.

        • levelOfControl

          Ayarın kontrol düzeyi.

        • value

          T

          Ayarın değişiklikten sonraki değeri.

  • clear

    void

    Söz

    Ayarı temizleyerek varsayılan değerleri geri yükler.

    clear işlevi şu şekilde görünür:

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

    • ayrıntılar

      nesne

      Hangi ayarın temizleneceği.

      • kapsam

        ChromeSettingScope isteğe bağlı

        Ayarın temizleneceği yer (varsayılan: normal).

    • geri çağırma

      Functions (isteğe bağlı)

      callback parametresi şu şekilde görünür:

      ()=>void

    • returns

      Promise<void>

      Chrome 96 ve sonraki sürümler

      Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

  • get

    void

    Söz

    Bir ayarın değerini alır.

    get işlevi şu şekilde görünür:

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

    • ayrıntılar

      nesne

      Göz önünde bulundurulması gereken ayar.

      • gizli

        boole isteğe bağlı

        Gizli oturuma uygulanan değerin döndürülüp döndürülmeyeceğini belirtir (varsayılan değer false).

    • geri çağırma

      Functions (isteğe bağlı)

      callback parametresi şu şekilde görünür:

      (details: object)=>void

      • ayrıntılar

        nesne

        Geçerli olarak geçerli değerin ayrıntıları.

        • incognitoSpecific

          boole isteğe bağlı

          Etkili değerin gizli oturuma özel olup olmadığı. Bu özellik yalnızca get() öğesinin details parametresindeki incognito özelliği doğru olduğunda mevcut olur.

        • levelOfControl

          Ayarın kontrol düzeyi.

        • value

          T

          Ayarın değeri.

    • returns

      Promise<object>

      Chrome 96 ve sonraki sürümler

      Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

  • ayarla

    void

    Söz

    Bir ayarın değerini belirler.

    set işlevi şu şekilde görünür:

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

    • ayrıntılar

      nesne

      Hangi ayarın değiştirileceği.

      • kapsam

        ChromeSettingScope isteğe bağlı

        Ayarın yapılacağı yer (varsayılan: normal).

      • value

        T

        Ayarın değeri. Her ayarın, ayarla birlikte açıklanan belirli bir değer türü olduğunu unutmayın. Bir uzantı, farklı türde bir değer ayarlamamalıdır.

    • geri çağırma

      Functions (isteğe bağlı)

      callback parametresi şu şekilde görünür:

      ()=>void

    • returns

      Promise<void>

      Chrome 96 ve sonraki sürümler

      Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

ChromeSettingScope

Chrome 44 ve sonraki sürümler

ChromeSetting kapsamı. Şunlardan biri:

  • regular: normal profil için ayar (başka bir yerde geçersiz kılınmadığı takdirde gizli profil tarafından devralınır),
  • regular\_only: Yalnızca normal profil için ayar (gizli profil tarafından devralınmaz),
  • incognito\_persistent: Tarayıcı yeniden başlatıldıktan sonra hayatta kalan gizli profil ayarı (normal tercihleri geçersiz kılar),
  • incognito\_session\_only: Yalnızca gizli oturum sırasında ayarlanabilen ve gizli oturum sona erdiğinde silinen gizli profil ayarıdır (normal ve secret_persistent tercihlerini geçersiz kılar).

Enum

"regular" (normal)

"regular_only"

LevelOfControl

Chrome 44 ve sonraki sürümler

Şunlardan biri:

  • not\_controllable: Herhangi bir uzantı tarafından kontrol edilemez
  • controlled\_by\_other\_extensions: Daha yüksek önceliğe sahip uzantılar tarafından kontrol edilir
  • controllable\_by\_this\_extension: Bu uzantı tarafından kontrol edilebilir
  • controlled\_by\_this\_extension: Bu uzantı tarafından kontrol ediliyor

Enum

"not_controllable"

"controlled_by_other_extensions"

"controllable_by_this_extension"

"controlled_by_this_extension"