experiments.rst

≡ experiments API

• Manifest file properties
• Types

experiments API

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

Manifest file properties

.. api-member::
   :name: [``experiment_apis``]
   :type: (object, optional)

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

Types

APIChildScope

.. api-section-annotation-hack::

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


   .. container:: api-member-node

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

         Supported values:

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

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

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

APIEvent

.. api-section-annotation-hack::

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


   .. container:: api-member-node

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

         Supported values:

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

APIEvents

.. api-section-annotation-hack::

.. api-header::
   :label: array of :ref:`experiments.APIEvent`

APIParentScope

.. api-section-annotation-hack::

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


   .. container:: api-member-node

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

         Supported values:

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

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

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

APIPath

.. api-section-annotation-hack::

.. api-header::
   :label: array of string

APIPaths

.. api-section-annotation-hack::

.. api-header::
   :label: array of :ref:`experiments.APIPath`

ExperimentAPI

.. api-section-annotation-hack::

.. api-header::
   :label: object


   .. api-member::
      :name: ``schema``
      :type: (:ref:`experiments.ExperimentURL`)


   .. api-member::
      :name: [``child``]
      :type: (object, optional)

      .. api-member::
         :name: ``paths``
         :type: (:ref:`experiments.APIPaths`)


      .. api-member::
         :name: ``scopes``
         :type: (array of :ref:`experiments.APIChildScope`)


      .. api-member::
         :name: ``script``
         :type: (:ref:`experiments.ExperimentURL`)



   .. api-member::
      :name: [``parent``]
      :type: (object, optional)

      .. api-member::
         :name: ``script``
         :type: (:ref:`experiments.ExperimentURL`)


      .. api-member::
         :name: [``events``]
         :type: (:ref:`experiments.APIEvents`, optional)


      .. api-member::
         :name: [``paths``]
         :type: (:ref:`experiments.APIPaths`, optional)


      .. api-member::
         :name: [``scopes``]
         :type: (array of :ref:`experiments.APIParentScope`, optional)

ExperimentURL

.. api-section-annotation-hack::

.. api-header::
   :label: string