Add API documentation for the publishing permissions property

Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>

3 files changed, 27 insertions, 0 deletions

diff --git a/docs/constants.md b/docs/constants.md
index 62c3291b8..0946ee557 100644
--- a/docs/constants.md
+++ b/docs/constants.md
@@ -57,6 +57,12 @@ title: Constants
 * `guests` - Guest without a login
 * `emails` - A guest invited by email address
 
+### Attendee publishing permissions
+* `0` None
+* `1` Audio
+* `2` Video
+* `4` Screensharing
+
 ### Actor types of chat messages
 * `users` - Logged-in users
 * `guests` - Guest users (attendee type `guests` and `emails`)
diff --git a/docs/conversation.md b/docs/conversation.md
index d2d139d1e..4c52215cb 100644
--- a/docs/conversation.md
+++ b/docs/conversation.md
@@ -37,6 +37,7 @@
         `attendeePin` | string | v3 | | Unique dial-in authentication code for this user, when the conversation has SIP enabled (see `sipEnabled` attribute)
         `actorType` | string | v3 | | Currently known `users|guests|emails|groups|circles`
         `actorId` | string | v3 | | The unique identifier for the given actor type
+        `publishingPermissions` | int | v4 | Publishing permissions for the current participant (see [constants list](constants.md#attendee-publishing-permissions))
         `participantInCall` | bool | v1 | v2 | **Removed:** use `participantFlags` instead
         `participantFlags` | int | v1 | | "In call" flags of the user's session making the request (only available with `in-call-flags` capability)
         `readOnly` | int | v1 | | Read-only state for the current user (only available with `read-only-rooms` capability)
diff --git a/docs/participant.md b/docs/participant.md
index 336f6bf4b..c2dfab1b2 100644
--- a/docs/participant.md
+++ b/docs/participant.md
@@ -34,6 +34,7 @@
         `participantType` | int | v1 | | Permissions level of the participant (see [constants list](constants.md#participant-types))
         `lastPing` | int | v1 | | Timestamp of the last ping of the user (should be used for sorting)
         `inCall` | int | v1 | | Call flags the user joined with (see [constants list](constants.md#participant-in-call-flag))
+        `publishingPermissions` | int | v4 | Publishing permissions for the participant (see [constants list](constants.md#attendee-publishing-permissions))
         `sessionId` | string | v1 | v4 | `'0'` if not connected, otherwise a 512 character long string
         `sessionIds` | array | v4 | | array of session ids, each are 512 character long strings, or empty if no session
         `status` | string | v2 | | Optional: Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
@@ -190,6 +191,25 @@
         + `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
+
+* Method: `PUT`
+* Endpoint: `/room/{token}/attendees/publishing-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)
+
+* Response:
+    - Status code:
+        + `200 OK`
+        + `400 Bad Request` When the conversation type does not support setting publishing permissions (only group and public conversations)
+        + `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
+
 ## Get a participant by their pin
 
 Note: This is only allowed with validate SIP bridge requests