diff options
| author | Joas Schilling <coding@schilljs.com> | 2020-05-29 11:37:52 +0300 |
|---|---|---|
| committer | backportbot[bot] <backportbot[bot]@users.noreply.github.com> | 2020-07-01 14:11:39 +0300 |
| commit | 2939bd9e038f1cc035446b0d10d359f967b7954f (patch) | |
| tree | cafc45ca095e152ee460362c0942aa772262ed4c /docs | |
| parent | 73603d4e09c1c68e628263d055b1db590eed79d6 (diff) | |
Add documentation for the conflict handling
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/participant.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/participant.md b/docs/participant.md index 3482581f4..bb72dd0e4 100644 --- a/docs/participant.md +++ b/docs/participant.md @@ -109,18 +109,28 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` field | type | Description ------|------|------------ `password` | string | Optional: Password is only required for users which are of type `4` or `5` and only when the conversation has `hasPassword` set to true. + `force` | bool | If set to `false` and the user has an active session already a `409 Conflict` will be returned (Default: true - to keep the old behaviour) * Response: - Status code: + `200 OK` + `403 Forbidden` When the password is required and didn't match + `404 Not Found` When the conversation could not be found for the participant + + `409 Conflict` When the user already has an active session in the conversation. The suggested behaviour is to ask the user whether they want to kill the old session and force join unless the last ping is older than 60 seconds or older than 40 seconds when the conflicting session is not marked as in a call. - - Data: + - Data in case of `200 OK`: + + field | type | Description + ------|------|------------ + `sessionId` | string | 512 character long string + + - Data in case of `409 Conflict`: field | type | Description ------|------|------------ `sessionId` | string | 512 character long string + `inCall` | int | Flags whether the conflicting session is in a potential call + `lastPing` | int | Timestamp of the last ping of the conflicting session ## Leave a conversation (not available for call and chat anymore) |