diff options
| author | Joas Schilling <coding@schilljs.com> | 2021-09-01 18:28:19 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2021-09-20 13:51:19 +0300 |
| commit | bf6150be9549813459f26a92cfafaa114331cebe (patch) | |
| tree | 68ec559bba93f0198cfc79fdb19111ab435f268d /docs | |
| parent | 9aff2302dfc1f94c607e0296ca14a620c2758cdb (diff) | |
Add a counter for the direct mentions
This allows the UI can show the user bubble depending on user vs. all mentions
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/capabilities.md | 3 | ||||
| -rw-r--r-- | docs/conversation.md | 1 |
2 files changed, 4 insertions, 0 deletions
diff --git a/docs/capabilities.md b/docs/capabilities.md index a08306bd4..e26e40889 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -81,3 +81,6 @@ title: Capabilities ## 12.1 * `clear-history` - Whether chat API has the endpoint so moderators can clear the complete history of a chat + +## 13 +* `direct-mention-flag` - The conversation list populates the boolean `unreadMentionDirect` when the user was mentioned directly (ignoring @all mentions) since their last visit diff --git a/docs/conversation.md b/docs/conversation.md index d998ee0d4..237f93ad2 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -67,6 +67,7 @@ `canEnableSIP` | int | v3 | | Whether the given user can enable SIP for this conversation. Note that when the token is not-numeric only, SIP can not be enabled even if the user is permitted and a moderator of the conversation `unreadMessages` | int | v1 | | Number of unread chat messages in the conversation (only available with `chat-v2` capability) `unreadMention` | bool | v1 | | Flag if the user was mentioned since their last visit + `unreadMentionDirect` | bool | v4 | | Flag if the user was mentioned directly (ignoring @all mentions) since their last visit (only available with `direct-mention-flag` capability) `lastReadMessage` | int | v1 | | 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 | v1 | | Last message in a conversation if available, otherwise empty |