Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/spreed.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2022-01-20 16:57:09 +0300
committerJoas Schilling <coding@schilljs.com>2022-01-21 17:19:49 +0300
commit189f507c5b9e88704cc6c53b94be81b0d6c0a5fd (patch)
treeeb073c87c055ebb6ab9b0ce67866747b33f19a31 /docs
parent764805f01787a19a5f19ac0f6c227f40fe449b68 (diff)
Allow to mark a conversation as unread
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/capabilities.md3
-rw-r--r--docs/chat.md19
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/capabilities.md b/docs/capabilities.md
index ce9739805..4acdb4274 100644
--- a/docs/capabilities.md
+++ b/docs/capabilities.md
@@ -85,3 +85,6 @@ title: Capabilities
## 13
* `direct-mention-flag` - The conversation list populates the boolean `unreadMentionDirect` when the user was mentioned directly (ignoring @all mentions) since their last visit
* `notification-calls` - Whether the API to opt out of call notifications is available
+
+## 14
+* `chat-unread` - Whether the API to mark a conversation as unread is available
diff --git a/docs/chat.md b/docs/chat.md
index b19573ecb..ff03979ef 100644
--- a/docs/chat.md
+++ b/docs/chat.md
@@ -230,6 +230,25 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
`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)
+## Mark chat as unread
+
+* Required capability: `chat-unread`
+* Method: `DELETE`
+* Endpoint: `/chat/{token}/read`
+
+* Response:
+ - Status code:
+ + `200 OK`
+ + `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
* Method: `GET`