Skip to content

Commit

Permalink
include schema changes from bug bug1683720
Browse files Browse the repository at this point in the history
  • Loading branch information
jobisoft committed Dec 22, 2020
1 parent 3b5e80c commit 41b0a7c
Show file tree
Hide file tree
Showing 9 changed files with 32 additions and 42 deletions.
4 changes: 3 additions & 1 deletion browserAction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ getBadgeText(details)

.. api-section-annotation-hack::

Gets the badge text of the toolbar action. If no tab nor window is specified is specified, the global badge text is returned.
Gets the badge text of the toolbar action. If no tab nor window is specified, the global badge text is returned.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -482,6 +482,8 @@ ColorArray

.. api-section-annotation-hack::

An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is ``[255, 0, 0, 255]``.

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

Expand Down
2 changes: 1 addition & 1 deletion compose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ Used by various functions to represent the state of a message being composed. No
:type: (string)
:annotation: -- [Added in TB 76]

The ID of an identity from the :doc:`accounts` API. The settings from the identity will be used in the composed message. If ``replyTo`` is also specified, the ``replyTo`` property of the identity is overridden. The permission ``accountsRead`` is required to include the ``identityId``.
The ID of an identity from the :doc:`accounts` API. The settings from the identity will be used in the composed message. If ``replyTo`` is also specified, the ``replyTo`` property of the identity is overridden. The permission :permission:`accountsRead` is required to include the ``identityId``.


.. api-member::
Expand Down
4 changes: 3 additions & 1 deletion composeAction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ getBadgeText(details)

.. api-section-annotation-hack::

Gets the badge text of the toolbar action. If no tab nor window is specified is specified, the global badge text is returned.
Gets the badge text of the toolbar action. If no tab nor window is specified, the global badge text is returned.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -487,6 +487,8 @@ ColorArray

.. api-section-annotation-hack::

An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is ``[255, 0, 0, 255]``.

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

Expand Down
4 changes: 2 additions & 2 deletions mailTabs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Modifies the properties of a mail tab. Properties that are not specified in ``up
:name: [``displayedFolder``]
:type: (:ref:`folders.MailFolder`)

Sets the folder displayed in the tab. The extension must have an accounts permission to do this.
Sets the folder displayed in the tab. The extension must have the :permission:`accountsRead` permission to do this.


.. api-member::
Expand Down Expand Up @@ -234,7 +234,7 @@ getSelectedMessages([tabId])

.. api-section-annotation-hack::

Lists the selected messages in the current folder. A messages permission is required to do this.
Lists the selected messages in the current folder.

.. api-header::
:label: Parameters
Expand Down
12 changes: 6 additions & 6 deletions menus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ Show the matching menu items from this extension instead of the default menu. Th
:name: [``tabId``]
:type: (integer)

Required when context is 'tab'. Requires 'tabs' permission.
Required when context is 'tab'. Requires the :permission:`tabs` permission.



Expand Down Expand Up @@ -539,7 +539,7 @@ ContextType

.. api-section-annotation-hack::

The different contexts a menu can appear in. Specifying 'all' is equivalent to the combination of all other contexts except for 'tab'.
The different contexts a menu can appear in. Specifying ``all`` is equivalent to the combination of all other contexts except for ``tab``.

.. api-header::
:label: `string`
Expand Down Expand Up @@ -707,7 +707,7 @@ Information sent when a context menu item is clicked.
:name: [``displayedFolder``]
:type: (:ref:`folders.MailFolder`)

The displayed folder, if the context menu was opened in the message list. The ``accountsRead`` permission is required.
The displayed folder, if the context menu was opened in the message list. The :permission:`accountsRead` permission is required.


.. api-member::
Expand All @@ -721,7 +721,7 @@ Information sent when a context menu item is clicked.
:name: [``frameUrl``]
:type: (string)

The URL of the frame of the element where the context menu was clicked, if it was in a frame.
The URL of the frame of the element where the context menu was clicked, if it was in a frame.


.. api-member::
Expand Down Expand Up @@ -763,14 +763,14 @@ Information sent when a context menu item is clicked.
:name: [``selectedFolder``]
:type: (:ref:`folders.MailFolder`)

The selected folder, if the context menu was opened in the folder pane. The ``accountsRead`` permission is required.
The selected folder, if the context menu was opened in the folder pane. The :permission:`accountsRead` permission is required.


.. api-member::
:name: [``selectedMessages``]
:type: (:ref:`messages.MessageList`)

The selected messages, if the context menu was opened in the message list. The ``messagesRead`` permission is required.
The selected messages, if the context menu was opened in the message list. The :permission:`messagesRead` permission is required.


.. api-member::
Expand Down
4 changes: 3 additions & 1 deletion messageDisplayAction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ getBadgeText(details)

.. api-section-annotation-hack::

Gets the badge text of the toolbar action. If no tab nor window is specified is specified, the global badge text is returned.
Gets the badge text of the toolbar action. If no tab nor window is specified, the global badge text is returned.

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -480,6 +480,8 @@ ColorArray

.. api-section-annotation-hack::

An array of four integers in the range [0,255] that make up the RGBA color. For example, opaque red is ``[255, 0, 0, 255]``.

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

Expand Down
2 changes: 1 addition & 1 deletion messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ Gets all messages that have the specified properties, or all messages if no prop
:name: [``folder``]
:type: (:ref:`folders.MailFolder`)

Returns only messages from the specified folder. The ``accountsRead`` permission is required.
Returns only messages from the specified folder. The :permission:`accountsRead` permission is required.


.. api-member::
Expand Down
14 changes: 7 additions & 7 deletions tabs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ Duplicates a tab.
.. api-member::
:type: :ref:`tabs.Tab`

Details about the duplicated tab. The :ref:`tabs.Tab` object doesn't contain ``url``, ``title`` and ``favIconUrl`` if the ``"tabs"`` permission has not been requested.
Details about the duplicated tab. The :ref:`tabs.Tab` object doesn't contain ``url``, ``title`` and ``favIconUrl`` if the :permission:`tabs` permission has not been requested.


.. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
Expand Down Expand Up @@ -422,7 +422,7 @@ Modifies the properties of a tab. Properties that are not specified in ``updateP
.. api-member::
:type: :ref:`tabs.Tab`

Details about the updated tab. The :ref:`tabs.Tab` object doesn't contain ``url``, ``title`` and ``favIconUrl`` if the ``"tabs"`` permission has not been requested.
Details about the updated tab. The :ref:`tabs.Tab` object doesn't contain ``url``, ``title`` and ``favIconUrl`` if the :permission:`tabs` permission has not been requested.


.. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
Expand All @@ -434,7 +434,7 @@ move(tabIds, moveProperties)

.. api-section-annotation-hack::

Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal (window.type === "normal") windows.
Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal windows (``window.type === "normal"``).

.. api-header::
:label: Parameters
Expand Down Expand Up @@ -943,7 +943,7 @@ Tab
:name: [``favIconUrl``]
:type: (string)

The URL of the tab's favicon. This property is only present if the extension's manifest includes the ``"tabs"`` permission. It may also be an empty string if the tab is loading.
The URL of the tab's favicon. This property is only present if the extension's manifest includes the :permission:`tabs` permission. It may also be an empty string if the tab is loading.


.. api-member::
Expand Down Expand Up @@ -978,14 +978,14 @@ Tab
:name: [``title``]
:type: (string)

The title of the tab. This property is only present if the extension's manifest includes the ``"tabs"`` permission.
The title of the tab. This property is only present if the extension's manifest includes the :permission:`tabs` permission.


.. api-member::
:name: [``url``]
:type: (string)

The URL the tab is displaying. This property is only present if the extension's manifest includes the ``"tabs"`` permission.
The URL the tab is displaying. This property is only present if the extension's manifest includes the :permission:`tabs` permission.


.. api-member::
Expand Down Expand Up @@ -1057,7 +1057,7 @@ An object describing filters to apply to tabs.onUpdated events.
:name: [``urls``]
:type: (array of string)

A list of URLs or URL patterns. Events that cannot match any of the URLs will be filtered out. Filtering with urls requires the ``"tabs"`` or ``"activeTab"`` permission.
A list of URLs or URL patterns. Events that cannot match any of the URLs will be filtered out. Filtering with urls requires the :permission:`tabs` or :permission:`activeTab` permission.


.. api-member::
Expand Down
28 changes: 6 additions & 22 deletions windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,23 +123,7 @@ Gets all windows.

.. api-member::
:name: [``getInfo``]
:type: (object)

Specifies properties used to filter the :ref:`windows.Window` returned and to determine whether they should contain a list of the :ref:`tabs.Tab` objects.

.. api-member::
:name: [``populate``]
:type: (boolean)

If true, each :ref:`windows.Window` object will have a ``tabs`` property that contains a list of the :ref:`tabs.Tab` objects for that window. The ``Tab`` objects only contain the ``url``, ``title`` and ``favIconUrl`` properties if the extension's manifest file includes the ``"tabs"`` permission.


.. api-member::
:name: [``windowTypes``]
:type: (array of :ref:`windows.WindowType`)

If set, the :ref:`windows.Window` returned will be filtered based on its type.

:type: (:ref:`windows.GetInfo`)


.. api-header::
Expand Down Expand Up @@ -500,7 +484,7 @@ GetInfo

.. api-section-annotation-hack::

Specifies whether the :ref:`windows.Window` returned should contain a list of the :ref:`tabs.Tab` objects.
Specifies properties used to filter the :ref:`windows.Window` returned and to determine whether they should contain a list of the :ref:`tabs.Tab` objects.

.. api-header::
:label: object
Expand All @@ -510,14 +494,14 @@ Specifies whether the :ref:`windows.Window` returned should contain a list of th
:name: [``populate``]
:type: (boolean)

If true, the :ref:`windows.Window` returned will have a ``tabs`` property that contains a list of the :ref:`tabs.Tab` objects. The ``Tab`` objects only contain the ``url``, ``title`` and ``favIconUrl`` properties if the extension's manifest file includes the ``"tabs"`` permission.
If true, the :ref:`windows.Window` returned will have a ``tabs`` property that contains a list of the :ref:`tabs.Tab` objects. The ``Tab`` objects only contain the ``url``, ``title`` and ``favIconUrl`` properties if the extension's manifest file includes the :permission:`tabs` permission.


.. api-member::
:name: [``windowTypes``]
:type: (array of :ref:`windows.WindowType`) **Deprecated.**
:type: (array of :ref:`windows.WindowType`)

``windowTypes`` is deprecated and ignored on Thunderbird.
If set, the :ref:`windows.Window` returned will be filtered based on its type. Supported by :ref:`windows.getAll` only, ignored in all other functions.


.. _windows.Window:
Expand Down Expand Up @@ -657,7 +641,7 @@ WindowType

.. api-section-annotation-hack::

The type of window this is. Under some circumstances a Window may not be assigned type property.
The type of window this is. Under some circumstances a Window may not be assigned a type property.

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

0 comments on commit 41b0a7c

Please sign in to comment.