diff options
| author | Joas Schilling <coding@schilljs.com> | 2020-12-08 16:46:54 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2020-12-10 13:47:04 +0300 |
| commit | bc716c7199a1ed315e63d84e3f5f4501800af68b (patch) | |
| tree | e4669f0343be5b4e0972717cf5726c4d0e17a63d /docs | |
| parent | 6eefd9c3fae1d66d3a277f0b1e3d2a8e3a02418c (diff) | |
Add the last common read message id as header on chat requests and to the conversation list
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/chat.md | 13 | ||||
| -rw-r--r-- | docs/conversation.md | 1 |
2 files changed, 14 insertions, 0 deletions
diff --git a/docs/chat.md b/docs/chat.md index 0aa839904..11191c68f 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -29,6 +29,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) - Data: Array of messages, each message has at least: @@ -85,6 +86,12 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` + `412 Precondition Failed` When the lobby is active and the user is not a moderator + `413 Payload Too Large` When the message was longer than the allowed limit of 32000 characters (or 1000 until Nextcloud 16.0.1, check the `spreed => config => chat => max-length` capability for the limit) + - Header: + + field | type | Description + ------|------|------------ + `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) + - Data: The full message array of the new message, as defined in [Receive chat messages of a conversation](#receive-chat-messages-of-a-conversation) @@ -104,6 +111,12 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` + `404 Not Found` When the room could not be found for the participant, or the participant is a guest. + - Header: + + field | type | Description + ------|------|------------ + `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) + ## Get mention autocomplete suggestions diff --git a/docs/conversation.md b/docs/conversation.md index 9de4ea233..4c495507f 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -57,6 +57,7 @@ `unreadMessages` | int | * | Number of unread chat messages in the conversation (only available with `chat-v2` capability) `unreadMention` | bool | * | Flag if the user was mentioned since their last visit `lastReadMessage` | int | * | ID of the last read message in a room (only available with `chat-read-marker` capability) + `lastCommonReadMessage` | int | v3 | ID of the last message read by every user that has read privacy set to public in a room. When the user themself has it set to private the value is `0` (only available with `chat-read-status` capability) `lastMessage` | message | * | Last message in a conversation if available, otherwise empty `objectType` | string | * | The type of object that the conversation is associated with; "share:password" if the conversation is used to request a password for a share, otherwise empty `objectId` | string | * | Share token if "objectType" is "share:password", otherwise empty |