diff options
| author | Vincent Petry <vincent@nextcloud.com> | 2020-12-15 18:07:30 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-15 18:07:30 +0300 |
| commit | 897c9921379cc0cd6d54ba70cb5f1f748f4d47c2 (patch) | |
| tree | 0be65bd6ce7cb6b9dddcca343250fed94b19d2de /docs | |
| parent | 9a346a2d4b332472edb4a64ac5a5f34c4bdb99ba (diff) | |
| parent | e982ad0bae1a5a55b1fd555974eb66aa1064388c (diff) | |
Merge pull request #4762 from nextcloud/bugfix/noid/allow-to-respond-with-modified-common-read-value
Allow to respond with modified common read value on "not modified" messages
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/chat.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/chat.md b/docs/chat.md index 95700a8c9..d03cdac17 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -13,6 +13,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` `lookIntoFuture` | int | `1` Poll and wait for new message or `0` get history of a conversation `limit` | int | Number of chat messages to receive (100 by default, 200 at most) `lastKnownMessageId` | int | Serves as an offset for the query. The lastKnownMessageId for the next page is available in the `X-Chat-Last-Given` header. + `lastCommonReadId` | int | Send the last `X-Chat-Last-Common-Read` header you got, if you are interested in updates of the common read value. A 304 response does not allow custom headers and otherwise the server can not know if your value is modified or not. `timeout` | int | `$lookIntoFuture = 1` only, Number of seconds to wait for new messages (30 by default, 60 at most) `setReadMarker` | int | `1` to automatically set the read timer after fetching the messages, use `0` when your client calls `Mark chat as read` manually. (Default: `1`) `includeLastKnown` | int | `1` to include the last known message as well (Default: `0`) @@ -29,7 +30,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` field | type | Description ------|------|------------ `X-Chat-Last-Given` | int | Offset (lastKnownMessageId) for the next page. - `X-Chat-Last-Common-Read` | int | ID of the last message read by every user that has read privacy set to public. When the user themself has it set to private the value the header is not set (only available with `chat-read-status` capability) + `X-Chat-Last-Common-Read` | int | ID of the last message read by every user that has read privacy set to public. When the user themself has it set to private the value the header is not set (only available with `chat-read-status` capability and when lastCommonReadId was sent) - Data: Array of messages, each message has at least: |