Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/spreed.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2021-10-04 19:27:47 +0300
committerJoas Schilling <coding@schilljs.com>2021-10-07 19:18:32 +0300
commit31d0d2aed27677f022fe2f595ba8256b6d712281 (patch)
treead295c9a02f500325629ea540687cd51d7ed1ebe /docs
parent0985260164c188d5d7308c624e335dd3b08ada8b (diff)
Fix documentation
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/constants.md11
-rw-r--r--docs/conversation.md19
-rw-r--r--docs/participant.md30
3 files changed, 53 insertions, 7 deletions
diff --git a/docs/constants.md b/docs/constants.md
index ddbb4f74c..90423a13e 100644
--- a/docs/constants.md
+++ b/docs/constants.md
@@ -67,6 +67,11 @@ title: Constants
* `32` Can publish video stream
* `64` Can publish screenshare stream
+### Attendee permission modifications
+* `set` - Setting this permission set.
+* `add` - Add the given flags to the permissions.
+* `remove` - Remove the given flags from the permissions.
+
### Actor types of chat messages
* `users` - Logged-in users
* `guests` - Guest users (attendee type `guests` and `emails`)
@@ -74,6 +79,6 @@ title: Constants
* `bridged` - Users whose messages are bridged in by the [Matterbridge integration](matterbridge.md)
## Signaling modes
-* `internal` No external signaling server is used
-* `external` A single external signaling server is used
-* `conversation_cluster` An external signaling server is assigned per conversation
+* `internal` - No external signaling server is used
+* `external` - A single external signaling server is used
+* `conversation_cluster` - An external signaling server is assigned per conversation.
diff --git a/docs/conversation.md b/docs/conversation.md
index e15edf910..b22cd8587 100644
--- a/docs/conversation.md
+++ b/docs/conversation.md
@@ -248,6 +248,25 @@
+ `403 Forbidden` When the conversation is not a public conversation
+ `404 Not Found` When the conversation could not be found for the participant
+## Set default or call permissions for a conversation
+
+* Method: `PUT`
+* Endpoint: `/room/{token}/permissions/{mode}`
+* Data:
+
+ field | type | Description
+ ---|---|---
+ `mode` | string | `default` or `call`, in case of call the permissions will be reset to `Default` after the end of a call.
+ `permissions` | int | New permissions for the attendees, see [constants list](constants.md#attendee-permissions). If permissions are not `Default`, the `Custom` permission will always be added. Note that this will reset all custom permissions that have been given to attendees so far.
+
+* Response:
+ - Status code:
+ + `200 OK`
+ + `400 Bad Request` When the conversation type does not support setting publishing permissions, e.g. one-to-one conversations
+ + `400 Bad Request` When the mode is invalid
+ + `403 Forbidden` When the current user is not a moderator, owner or guest moderator
+ + `404 Not Found` When the conversation could not be found for the participant
+
## Add conversation to favorites
* Required capability: `favorites`
diff --git a/docs/participant.md b/docs/participant.md
index 4126bd6e0..7064a17eb 100644
--- a/docs/participant.md
+++ b/docs/participant.md
@@ -191,25 +191,47 @@
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the participant to demote could not be found
-## Set publishing permissions for an attendee
+## Set permissions for an attendee
* Method: `PUT`
-* Endpoint: `/room/{token}/attendees/publishing-permissions`
+* Endpoint: `/room/{token}/attendees/permissions`
* Data:
field | type | Description
---|---|---
`attendeeId` | int | Attendee id can be used for guests and users
- `state` | int | New state for the attendee, see [constants list](constants.md#attendee-publishing-permissions)
+ `mode` | string | Mode of how permissions should be manipulated [constants list](constants.md#attendee-permission-modifications). If the permissions were `Default` and the modification is `add` or `remove`, they will be initialised with the call or default conversation permissions before, falling back to 126 for moderators and 118 for normal participants.
+ `permissions` | int | New permissions for the attendee, see [constants list](constants.md#attendee-permissions). If permissions are not `Default`, the `Custom` permission will always be added.
* Response:
- Status code:
+ `200 OK`
- + `400 Bad Request` When the conversation type does not support setting publishing permissions (only group and public conversations)
+ + `400 Bad Request` When the conversation type does not support setting publishing permissions, e.g. one-to-one conversations
+ + `400 Bad Request` When the attendee type is `groups` or `circles`
+ + `400 Bad Request` When the mode is invalid
+ `403 Forbidden` When the current user is not a moderator, owner or guest moderator
+ `404 Not Found` When the conversation could not be found for the participant
+ `404 Not Found` When the attendee to set publishing permissions could not be found
+## Set permissions for all attendees
+
+* Method: `PUT`
+* Endpoint: `/room/{token}/attendees/permissions/all`
+* Data:
+
+ field | type | Description
+ ---|---|---
+ `mode` | string | Mode of how permissions should be manipulated [constants list](constants.md#attendee-permission-modifications). If the permissions were `Default` and the modification is `add` or `remove`, they will be initialised with the call or default conversation permissions before, falling back to 126 for moderators and 118 for normal participants.
+ `permissions` | int | New permissions for the attendees, see [constants list](constants.md#attendee-permissions). If permissions are not `Default`, the `Custom` permission will always be added.
+
+* Response:
+ - Status code:
+ + `200 OK`
+ + `400 Bad Request` When the conversation type does not support setting publishing permissions, e.g. one-to-one conversations
+ + `400 Bad Request` When the mode is invalid
+ + `403 Forbidden` When the current user is not a moderator, owner or guest moderator
+ + `404 Not Found` When the conversation could not be found for the participant
+
## Get a participant by their pin
Note: This is only allowed with validate SIP bridge requests