privacy.network.rst

≡ privacy.network API

• Permissions
• Types
• Properties

privacy.network API

Use the browser.privacy API to control usage of the features in the browser that can affect a user's privacy.

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

Permissions

.. api-member::
   :name: :permission:`privacy`

   Read and modify privacy settings

.. rst-class:: api-permission-info

Note

The permission privacy is required to use messenger.privacy.network.*.

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

Types

HTTPSOnlyModeOption

.. api-section-annotation-hack::

The mode for https-only mode.

.. api-header::
   :label: `string`


   .. container:: api-member-node

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

         Supported values:

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

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

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

IPHandlingPolicy

.. api-section-annotation-hack::

The IP handling policy of WebRTC.

.. api-header::
   :label: `string`


   .. container:: api-member-node

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

         Supported values:

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

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

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

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

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

tlsVersionRestrictionConfig

.. api-section-annotation-hack::

An object which describes TLS minimum and maximum versions.

.. api-header::
   :label: object


   .. api-member::
      :name: [``maximum``]
      :type: (`string`, optional)

      The maximum TLS version supported.

      Supported values:

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

      .. api-member::
         :name: :value:`TLSv1.1`

      .. api-member::
         :name: :value:`TLSv1.2`

      .. api-member::
         :name: :value:`TLSv1.3`

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


   .. api-member::
      :name: [``minimum``]
      :type: (`string`, optional)

      The minimum TLS version supported.

      Supported values:

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

      .. api-member::
         :name: :value:`TLSv1.1`

      .. api-member::
         :name: :value:`TLSv1.2`

      .. api-member::
         :name: :value:`TLSv1.3`

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

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

Properties

globalPrivacyControl

.. api-section-annotation-hack::

Allow users to query the status of 'Global Privacy Control'. This setting's value is of type boolean, defaulting to false.

httpsOnlyMode

.. api-section-annotation-hack::

Allow users to query the mode for 'HTTPS-Only Mode'. This setting's value is of type HTTPSOnlyModeOption, defaulting to never.

networkPredictionEnabled

.. api-section-annotation-hack::

If enabled, the browser attempts to speed up your web browsing experience by pre-resolving DNS entries, prerendering sites (<link rel='prefetch' ...>), and preemptively opening TCP and SSL connections to servers. This preference's value is a boolean, defaulting to true.

peerConnectionEnabled

.. api-section-annotation-hack::

Allow users to enable and disable RTCPeerConnections (aka WebRTC).

tlsVersionRestriction

.. api-section-annotation-hack::

This property controls the minimum and maximum TLS versions. This setting's value is an object of :ref:`tlsVersionRestrictionConfig`.

webRTCIPHandlingPolicy

.. api-section-annotation-hack::

Allow users to specify the media performance/privacy tradeoffs which impacts how WebRTC traffic will be routed and how much local address information is exposed. This preference's value is of type IPHandlingPolicy, defaulting to default.