хром.типы

Описание

API chrome.types содержит объявления типов для Chrome.

Настройки Chrome

Прототип ChromeSetting предоставляет стандартный набор функций ( get() , set() и clear() ), а также публикатор событий ( onChange ) для настроек браузера Chrome. Примеры настроек прокси-сервера демонстрируют, как предполагается использовать эти функции.

Область применения и жизненный цикл

Chrome различает три различных области настроек браузера:

regular
Настройки, заданные в regular области действия, применяются к обычным окнам браузера и наследуются окнами в режиме инкогнито, если они не перезаписаны. Эти настройки сохраняются на диске и остаются в силе до тех пор, пока не будут удалены управляющим расширением или пока управляющее расширение не будет отключено или удалено.
incognito_persistent
Параметры, заданные в области действия incognito_persistent , применяются только к окнам в режиме инкогнито. Для них они переопределяют regular настройки. Эти настройки сохраняются на диске и действуют до тех пор, пока не будут удалены управляющим расширением или пока управляющее расширение не будет отключено или удалено.
incognito_session_only
Параметры, заданные в области действия incognito_session_only применяются только к окнам в режиме инкогнито. Для них они переопределяют regular параметры и параметры incognito_persistent . Эти параметры не сохраняются на диске и сбрасываются при закрытии последнего окна в режиме инкогнито. Их можно задать только при открытом хотя бы одном окне в режиме инкогнито.

Приоритет

Chrome управляет настройками на разных уровнях. В следующем списке в порядке возрастания приоритета описываются уровни, которые могут влиять на эффективные настройки.

  1. Системные настройки, предоставляемые операционной системой
  2. Параметры командной строки
  3. Настройки, предоставляемые расширениями
  4. Политики

Как следует из списка, политики могут переопределять любые изменения, указанные вами в вашем расширении. Вы можете использовать функцию get() , чтобы определить, может ли ваше расширение предоставлять настройку или эта настройка будет переопределена.

Как обсуждалось выше, Chrome позволяет использовать разные настройки для обычных окон и окон в режиме инкогнито. Следующий пример иллюстрирует это поведение. Предположим, что ни одна политика не переопределяет настройки, и расширение может устанавливать настройки для обычных окон (R) и настройки для окон в режиме инкогнито (I) .

  • Если установлено только (R) , эти настройки действуют как для обычных окон, так и для окон в режиме инкогнито.
  • Если установлено только (I) , эти настройки действуют только для окон в режиме инкогнито. Обычные окна используют настройки, определяемые нижними уровнями (параметрами командной строки и системными настройками).
  • Если установлены оба параметра (R) и (I) , соответствующие настройки используются для обычных окон и окон в режиме инкогнито.

Если два или более расширений задают разные значения для одного и того же параметра, приоритет имеет расширение, установленное последним. Если последнее установленное расширение задаёт только (I) , настройки обычных окон можно определить с помощью ранее установленных расширений.

Эффективное значение параметра определяется с учётом правил приоритета. Оно используется Chrome.

Типы

ChromeSetting

Интерфейс, обеспечивающий доступ к настройкам браузера Chrome. Пример см. в разделе accessibilityFeatures .

Характеристики

  • onChange

    Событие<functionvoidvoid>

    Срабатывает после изменения настроек.

    Функция onChange.addListener выглядит так: 

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

    • перезвонить

      функция

      Параметр callback выглядит так: 

      (details: object) => void

      • подробности

        объект

        • инкогнитоСпецифический

          логическое необязательное

          Относится ли изменившееся значение к сеансу инкогнито. Это свойство будет присутствовать только в том случае, если пользователь включил расширение в режиме инкогнито.

        • уровень контроля

          УровеньКонтроля

          Уровень контроля обстановки.

        • ценить

          Т

          Значение настройки после изменения.

  • прозрачный

    пустота

    Обещать

    Очищает настройки, восстанавливая все значения по умолчанию.

    Функция clear выглядит так: 

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

    • подробности

      объект

      Какие настройки следует очистить.

      • объем

        ChromeSettingScope (необязательно)

        Где очистить настройку (по умолчанию: обычно).

    • перезвонить

      функция необязательна

      Параметр callback выглядит так: 

      () => void

    • возвращается

      Обещание<void>

      Хром 96+

      Обещания поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

  • получать

    пустота

    Обещать

    Получает значение настройки.

    Функция get выглядит так: 

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

    • подробности

      объект

      Какую обстановку следует учитывать.

      • инкогнито

        логическое необязательное

        Возвращать ли значение, применяемое к сеансу инкогнито (по умолчанию false).

    • перезвонить

      функция необязательна

      Параметр callback выглядит так: 

      (details: object) => void

      • подробности

        объект

        Подробная информация о текущем эффективном значении.

        • инкогнитоСпецифический

          логическое необязательное

          Является ли эффективное значение специфичным для сеанса в режиме инкогнито. Это свойство будет присутствовать только в том случае, если свойство incognito в параметре details метода get() имеет значение true.

        • уровень контроля

          УровеньКонтроля

          Уровень контроля обстановки.

        • ценить

          Т

          Значение настройки.

    • возвращается

      Обещание<объект>

      Хром 96+

      Обещания поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

  • набор

    пустота

    Обещать

    Устанавливает значение параметра.

    Функция set выглядит так: 

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

    • подробности

      объект

      Какие настройки следует изменить.

      • объем

        ChromeSettingScope (необязательно)

        Где установить настройку (по умолчанию: обычная).

      • ценить

        Т

        Значение параметра. Обратите внимание, что каждый параметр имеет определённый тип значения, который описывается вместе с параметром. Расширение не должно задавать значение другого типа.

    • перезвонить

      функция необязательна

      Параметр callback выглядит так: 

      () => void

    • возвращается

      Обещание<void>

      Хром 96+

      Обещания поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

ChromeSettingScope

Хром 44+

Область действия ChromeSetting. Одна из

  • regular : настройка для обычного профиля (которая наследуется профилем incognito, если не переопределена где-либо еще),
  • regular\_only : настройка только для обычного профиля (не наследуется профилем инкогнито),
  • incognito\_persistent : настройка для профиля инкогнито, который сохраняется после перезапуска браузера (переопределяет обычные настройки),
  • incognito\_session\_only : настройка для профиля инкогнито, которая может быть установлена только во время сеанса инкогнито и удаляется после завершения сеанса инкогнито (переопределяет настройки regular и incognito_persistent).

Перечисление

"обычный"

"regular_only"

"incognito_persistent"

"incognito_session_only"

LevelOfControl

Хром 44+

Один из

  • not\_controllable : не может контролироваться никаким расширением
  • controlled\_by\_other\_extensions : управляются расширениями с более высоким приоритетом
  • controllable\_by\_this\_extension : может управляться этим расширением
  • controlled\_by\_this\_extension : управляется этим расширением

Перечисление

"не_контролируемый"

"controlled_by_other_extensions"

"контролируемое_этим_расширением"

"controlled_by_this_extension"