Skip to content

Commit

Permalink
mark changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jobisoft committed Oct 23, 2023
1 parent 6e88bbd commit a519757
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
5 changes: 4 additions & 1 deletion messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Returns the next chunk of messages in a list. See :doc:`how-to/messageLists` for
abortList(messageListId)
------------------------

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

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

Expand Down Expand Up @@ -429,6 +429,7 @@ Gets all messages that have the specified properties, or all messages if no prop
.. api-member::
:name: [``autoPaginationTimeout``]
:type: (integer, optional)
:annotation: -- [Added in TB 120]

Set the timeout in ms after which results should be returned, even if the nominal number of messages-per-page has not yet been reached. Defaults to :value:`1000` ms. Setting it to :value:`0` will disable auto-pagination.

Expand Down Expand Up @@ -494,6 +495,7 @@ Gets all messages that have the specified properties, or all messages if no prop
.. api-member::
:name: [``messagesPerPage``]
:type: (integer, optional)
:annotation: -- [Added in TB 120]

Set the nominal number of messages-per-page for this query. Defaults to :value:`100` messages.

Expand All @@ -508,6 +510,7 @@ Gets all messages that have the specified properties, or all messages if no prop
.. api-member::
:name: [``returnMessageListId``]
:type: (boolean, optional)
:annotation: -- [Added in TB 120]

The *messageListId* is usually returned together with the first page, after some messages have been found. Enabling this option will change the return value of this function and return the *messageListId* directly.

Expand Down
13 changes: 13 additions & 0 deletions overlay/messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@
"name": "import",
"added": "106"
},
{
"name": "abortList",
"added": "120"
},
{
"name": "query",
"added": "69",
Expand All @@ -55,6 +59,15 @@
"attachment": {
"added": "96",
"backported": "91.4.1"
},
"autoPaginationTimeout": {
"added": "120"
},
"messagesPerPage": {
"added": "120"
},
"returnMessageListId": {
"added": "120"
}
}
}
Expand Down

0 comments on commit a519757

Please sign in to comment.