diff options
| author | Joas Schilling <coding@schilljs.com> | 2020-08-05 18:16:47 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2020-08-05 20:27:35 +0300 |
| commit | ab2d01235eb2c9f636d2218064c25cdf5b41a5d5 (patch) | |
| tree | 1a45ec5f97c43bd8a4974794747cdf1d26372c4a /docs | |
| parent | edf066b566f918286c5a525ab20918584f9378de (diff) | |
Add docs about status
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/chat.md | 4 | ||||
| -rw-r--r-- | docs/participant.md | 8 |
2 files changed, 12 insertions, 0 deletions
diff --git a/docs/chat.md b/docs/chat.md index d769f97c8..0aa839904 100644 --- a/docs/chat.md +++ b/docs/chat.md @@ -116,6 +116,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` ------|------|------------ `search` | string | Search term for name suggestions (should at least be 1 character) `limit` | int | Number of suggestions to receive (20 by default) + `includeStatus` | bool | Whether the user status information also needs to be loaded * Response: - Status code: @@ -132,6 +133,9 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` `id` | string | The user id which should be sent as `@<id>` in the message (user ids that contain spaces as well as guest ids need to be wrapped in double-quotes when sending in a message: `@"space user"` and `@"guest/random-string"`) `label` | string | The displayname of the user `source` | string | The type of the user, currently only `users`, `guests` or `calls` (for mentioning the whole conversation + `status` | string | Optional: Only available with `includeStatus=true` and for users with a set status + `statusIcon` | string | Optional: Only available with `includeStatus=true` and for users with a set status + `statusMessage` | string | Optional: Only available with `includeStatus=true` and for users with a set status ## System messages diff --git a/docs/participant.md b/docs/participant.md index bb72dd0e4..245ea387d 100644 --- a/docs/participant.md +++ b/docs/participant.md @@ -6,6 +6,11 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` * Method: `GET` * Endpoint: `/room/{token}/participants` +* Data: + + field | type | Description + ------|------|------------ + `includeStatus` | bool | Whether the user status information also needs to be loaded * Response: - Status code: @@ -24,6 +29,9 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` `participantType` | int | Permissions level of the participant `lastPing` | int | Timestamp of the last ping of the user (should be used for sorting) `sessionId` | string | `'0'` if not connected, otherwise a 512 character long string + `status` | string | Optional: Only available with `includeStatus=true` and for users with a set status + `statusIcon` | string | Optional: Only available with `includeStatus=true` and for users with a set status + `statusMessage` | string | Optional: Only available with `includeStatus=true` and for users with a set status ## Add a participant to a conversation |