Skip to content

Commit

Permalink
resort
Browse files Browse the repository at this point in the history
  • Loading branch information
jobisoft committed Dec 1, 2023
1 parent 7044c0f commit bd8b8bb
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 61 deletions.
112 changes: 56 additions & 56 deletions messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -663,6 +663,62 @@ Updates message properties and tags. Updating external messages will throw an *E
- :permission:`messagesRead`
- :permission:`messagesUpdate`

.. _messages.abortList:

abortList(messageListId)
------------------------

.. api-section-annotation-hack:: -- [Added in TB 120]

Finalizes the specified list and terminates any process currently still adding messages.

.. api-header::
:label: Parameters


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


.. api-header::
:label: Required permissions

- :permission:`messagesRead`

.. _messages.continueList:

continueList(messageListId)
---------------------------

.. api-section-annotation-hack::

Returns the next chunk of messages in a list. See :doc:`how-to/messageLists` for more information.

.. api-header::
:label: Parameters


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


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


.. api-member::
:type: :ref:`messages.MessageList`


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

.. api-header::
:label: Required permissions

- :permission:`messagesRead`

.. _messages.getAttachmentFile:

getAttachmentFile(messageId, partName)
Expand Down Expand Up @@ -769,62 +825,6 @@ Opens the specified attachment
The ID of the tab associated with the message opening.


.. api-header::
:label: Required permissions

- :permission:`messagesRead`

.. _messages.abortList:

abortList(messageListId)
------------------------

.. api-section-annotation-hack:: -- [Added in TB 120]

Finalizes the specified list and terminates any process currently still adding messages.

.. api-header::
:label: Parameters


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


.. api-header::
:label: Required permissions

- :permission:`messagesRead`

.. _messages.continueList:

continueList(messageListId)
---------------------------

.. api-section-annotation-hack::

Returns the next chunk of messages in a list. See :doc:`how-to/messageLists` for more information.

.. api-header::
:label: Parameters


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


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


.. api-member::
:type: :ref:`messages.MessageList`


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

.. api-header::
:label: Required permissions

Expand Down
10 changes: 5 additions & 5 deletions overlay/messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,30 +48,30 @@
"returns": {
"$ref": "extensionTypes.File"
},
"sort": "1"
"sort": "2"
},
{
"name": "listAttachments",
"added": "88",
"sort": "1"
"sort": "2"
},
{
"name": "openAttachment",
"added": "114",
"sort": "1"
"sort": "2"
},
{
"name": "import",
"added": "106"
},
{
"name": "continueList",
"sort": "2"
"sort": "1"
},
{
"name": "abortList",
"added": "120",
"sort": "2"
"sort": "1"
},
{
"name": "query",
Expand Down

0 comments on commit bd8b8bb

Please sign in to comment.