diff options
| author | Marcel Müller <marcel-mueller@gmx.de> | 2023-03-22 14:17:50 +0100 |
|---|---|---|
| committer | Marcel Müller <marcel-mueller@gmx.de> | 2023-03-22 14:19:44 +0100 |
| commit | b46b21f51fb237aabbe7585fec135a455cd115b2 (patch) | |
| tree | b377cf7242b5b7b13230cec10e0b767c7bcce5f9 /docs | |
| parent | fd6d04eebd01031ca2f6fe5dad52384ed73f0d32 (diff) | |
Adjust wording of `noStatusUpdate` parameter
Signed-off-by: Marcel Müller <marcel-mueller@gmx.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/chat.md | 2 | ||||
| -rw-r--r-- | docs/conversation.md | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/chat.md b/docs/chat.md index f72338e8a..2db6cd7b8 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -23,7 +23,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`: since Nextcloud 13 | `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`) | +| `noStatusUpdate` | int | When the user status should not be automatically set to online set to 1 (default 0) | | `markNotificationsAsRead` | int | `0` to not mark notifications as read (Default: `1`, only available with `chat-keep-notifications` capability) | * Response: diff --git a/docs/conversation.md b/docs/conversation.md index 5fa5c8dc3..315df3ed5 100644 --- a/docs/conversation.md +++ b/docs/conversation.md @@ -29,7 +29,7 @@ | field | type | Description | |------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `noStatusUpdate` | int | Whether the "online" user status of the current user should be "kept-alive" (`1`) or not (`0`) (defaults to `0`) | +| `noStatusUpdate` | int | When the user status should not be automatically set to online set to 1 (default 0) | | `includeStatus` | bool | Whether the user status information of all one-to-one conversations should be loaded (default false) | | `modifiedSince` | int | **Use with care as per note above.** When provided only conversations with a newer `lastActivity` (and one-to-one conversations when `includeStatus` is provided) are returned. | |