Skip to content
Snippets Groups Projects
Verified Commit ca59bf43 authored by Janne Mareike Koschinski's avatar Janne Mareike Koschinski
Browse files

feat: improve docs for backlog loading

parent 2fcb2cfa
No related branches found
No related tags found
No related merge requests found
Pipeline #2664 passed
...@@ -128,6 +128,10 @@ interface BacklogManager { ...@@ -128,6 +128,10 @@ interface BacklogManager {
* Loads backlog for `bufferId`, starting at message `first`, up to `last` * Loads backlog for `bufferId`, starting at message `first`, up to `last`
* (plus `additional` more messages after `last`) but at most `limit` * (plus `additional` more messages after `last`) but at most `limit`
* messages total. * messages total.
*
* first == -1 && last == -1: highest $limit messages
* last == -1: $msgid in [$first, ∞), highest $limit
* else: $msgid in [$first, $last), highest $limit messages
*/ */
requestBacklog(bufferId: BufferId, first: MsgId, last: MsgId, limit: Int, additional: Int) requestBacklog(bufferId: BufferId, first: MsgId, last: MsgId, limit: Int, additional: Int)
/** /**
...@@ -135,6 +139,15 @@ interface BacklogManager { ...@@ -135,6 +139,15 @@ interface BacklogManager {
* with certain `flags` set. * with certain `flags` set.
*/ */
requestBacklogFiltered(bufferId: BufferId, first: MsgId, last: MsgId, limit: Int, additional: Int, type: Int, flags: Int) requestBacklogFiltered(bufferId: BufferId, first: MsgId, last: MsgId, limit: Int, additional: Int, type: Int, flags: Int)
/**
* Same as `requestBacklog`, but only messages of a certain message `type`
* with certain `flags` set.
*
* first == -1 && last == -1: lowest $limit messages
* last == -1: $msgid in [$first, ∞), lowest $limit
* else: $msgid in [$first, $last), lowest $limit messages
*/
requestBacklogForward(bufferId: BufferId, first: MsgId, last: MsgId, limit: Int, type: Int, flags: Int)
/** /**
* Same as `requestBacklog`, but applied to all buffers. * Same as `requestBacklog`, but applied to all buffers.
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment