diff options
| author | Marcel Müller <marcel-mueller@gmx.de> | 2023-03-15 17:04:36 +0100 |
|---|---|---|
| committer | Marcel Müller <marcel-mueller@gmx.de> | 2023-03-16 12:44:07 +0100 |
| commit | d480f3af4fda882fe01c4ec523eb3ba7d62b5db2 (patch) | |
| tree | 0a4871c6fadf1a5a76ed3c5f7e428f068bf987b0 /docs | |
| parent | 049c56f4d85cd35bbba5079061cce0f0f9fda513 (diff) | |
Allow to retrieve messages without marking notifications as read
Signed-off-by: Marcel Müller <marcel-mueller@gmx.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/capabilities.md | 1 | ||||
| -rw-r--r-- | docs/chat.md | 20 |
2 files changed, 12 insertions, 9 deletions
diff --git a/docs/capabilities.md b/docs/capabilities.md index 1c1b52221..61f0a041a 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -111,3 +111,4 @@ * `config => call => breakout-rooms` - Whether breakout rooms are enabled on this instance * `config => call => recording` - Whether calls can be recorded (requires the High-performance backend server) * `single-conversation-status` - When the response of a single conversation can also return the user status +* `chat-keep-notifications` - Whether messages can be retrieved without marking notifications as read diff --git a/docs/chat.md b/docs/chat.md index 4de385b00..548a0905f 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -14,15 +14,17 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`: since Nextcloud 13 * Endpoint: `/chat/{token}` * Data: -| field | type | Description | -|----------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `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`) | +| field | type | Description | +|---------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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`) | +| `noStatusUpdate` | int | Whether the "online" user status of the current user should be "kept-alive" (`1`) or not (`0`) (defaults to `0`) | +| `markNotificationsAsRead` | int | `0` to not mark notifications as read (Default: `1`, only available with `chat-read-status` capability) | * Response: - Status code: |