Skip to content

Latest commit

 

History

History
118 lines (67 loc) · 2.79 KB

types.rst

File metadata and controls

118 lines (67 loc) · 2.79 KB
Raw

≡ types API

types API

Contains types used by other schemas.

.. rst-class:: api-main-section

Types

LevelOfControl

.. api-section-annotation-hack::

One of<ul>

  • not_controllable: cannot be controlled by any extension</li>
  • controlled_by_other_extensions: controlled by extensions with higher precedence</li>
  • controllable_by_this_extension: can be controlled by this extension</li>
  • controlled_by_this_extension: controlled by this extension</li></ul>
.. api-header::
   :label: `string`


   .. container:: api-member-node

      .. container:: api-member-description-only

         Supported values:

         .. api-member::
            :name: :value:`not_controllable`

         .. api-member::
            :name: :value:`controlled_by_other_extensions`

         .. api-member::
            :name: :value:`controllable_by_this_extension`

         .. api-member::
            :name: :value:`controlled_by_this_extension`

Setting

.. api-section-annotation-hack::


.. api-header::
   :label: object

   - ``clear(details, [callback])`` Clears the setting, restoring any default value.
   - ``get(details, callback)`` Gets the value of a setting.
   - ``set(details, [callback])`` Sets the value of a setting.

SettingScope

.. api-section-annotation-hack::

The scope of the Setting. One of<ul>

  • regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),</li>
  • regular_only: setting for the regular profile only (not inherited by the incognito profile),</li>
  • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),</li>
  • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).</li></ul> Only regular is supported by Firefox at this time.
.. api-header::
   :label: `string`


   .. container:: api-member-node

      .. container:: api-member-description-only

         Supported values:

         .. api-member::
            :name: :value:`regular`

         .. api-member::
            :name: :value:`regular_only`

         .. api-member::
            :name: :value:`incognito_persistent`

         .. api-member::
            :name: :value:`incognito_session_only`