diff options
author | Daniel Calviño Sánchez <danxuliu@gmail.com> | 2019-05-10 10:00:45 +0300 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2019-05-10 15:47:04 +0300 |
commit | 2825271bccfee46323a1465267f17d14ef43ab1c (patch) | |
tree | 9bbf79df181547f8d5876d09168c357292ee70c3 /lib/Controller | |
parent | c883f9f688c30411716125cf9cae9decaf83f704 (diff) |
Add document about invisible messages not returned by ChatController
Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
Diffstat (limited to 'lib/Controller')
-rw-r--r-- | lib/Controller/ChatController.php | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/Controller/ChatController.php b/lib/Controller/ChatController.php index ed2437ecc..b920f7478 100644 --- a/lib/Controller/ChatController.php +++ b/lib/Controller/ChatController.php @@ -200,6 +200,15 @@ class ChatController extends AEnvironmentAwareController { * If messages have been returned (status=200) the new $lastKnownMessageId * for the follow up query is available as `X-Chat-Last-Given` header. * + * The limit specifies the maximum number of messages that will be returned, + * although the actual number of returned messages could be lower if some + * messages are not visible to the participant. Note that if none of the + * messages are visible to the participant the returned number of messages + * will be 0, yet the status will still be 200. Also note that + * `X-Chat-Last-Given` may reference a message not visible and thus not + * returned, but it should be used nevertheless as the $lastKnownMessageId + * for the follow up query. + * * @param int $lookIntoFuture Polling for new messages (1) or getting the history of the chat (0) * @param int $limit Number of chat messages to receive (100 by default, 200 at most) * @param int $lastKnownMessageId The last known message (serves as offset) |