Skip to content

Latest commit

 

History

History
233 lines (129 loc) · 5.29 KB

extension.rst

File metadata and controls

233 lines (129 loc) · 5.29 KB

≡ extension API

extension API

The browser.extension API has utilities that can be used by any extension page. It includes support for exchanging messages between an extension and its content scripts or between extensions, as described in detail in $(topic:messaging)[Message Passing].

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

Functions

getBackgroundPage()

.. api-section-annotation-hack::

Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.

.. api-header::
   :label: Return type (`Promise`_)


   .. api-member::
      :type: `Window <https://developer.mozilla.org/en-US/docs/Web/API/Window>`__


   .. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

getURL(path)

.. api-section-annotation-hack::

Converts a relative path within an extension install directory to a fully-qualified URL.

.. api-header::
   :label: Parameters


   .. api-member::
      :name: ``path``
      :type: (string)

      A path to a resource within an extension expressed relative to its install directory.



.. api-header::
   :label: Return type (`Promise`_)


   .. api-member::
      :type: string

      The fully-qualified URL to the resource.


   .. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

getViews([fetchProperties])

.. api-section-annotation-hack::

Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.

.. api-header::
   :label: Parameters


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

      .. api-member::
         :name: [``tabId``]
         :type: (integer, optional)

         Find a view according to a tab id. If this field is omitted, returns all views.


      .. api-member::
         :name: [``type``]
         :type: (:ref:`extension.ViewType`, optional)

         The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'popup', 'sidebar'.


      .. api-member::
         :name: [``windowId``]
         :type: (integer, optional)

         The window to restrict the search to. If omitted, returns all views.




.. api-header::
   :label: Return type (`Promise`_)


   .. api-member::
      :type: array of `Window <https://developer.mozilla.org/en-US/docs/Web/API/Window>`__

      Array of global objects


   .. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

isAllowedFileSchemeAccess()

.. api-section-annotation-hack::

Retrieves the state of the extension's access to the 'file://' scheme (as determined by the user-controlled 'Allow access to File URLs' checkbox.

.. api-header::
   :label: Return type (`Promise`_)


   .. api-member::
      :type: boolean

      True if the extension can access the 'file://' scheme, false otherwise.


   .. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

isAllowedIncognitoAccess()

.. api-section-annotation-hack::

Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox.

.. api-header::
   :label: Return type (`Promise`_)


   .. api-member::
      :type: boolean

      True if the extension has access to Incognito mode, false otherwise.


   .. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise


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

Events

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

Types

ViewType

.. api-section-annotation-hack::

The type of extension view.

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


   .. container:: api-member-node

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

         Supported values:

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

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

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



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

Properties

inIncognitoContext

.. api-section-annotation-hack::

True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. The latter only applies to extensions with 'split' incognito_behavior.

lastError

.. api-section-annotation-hack::

Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be undefined.