Merge pull request #5194 from nextcloud/techdebt/noid/multi-session

👥 Multiple sessions 👥
nextcloud · Mar 9, 2021 · 2a2a43a · 2a2a43a
2 parents ab141f7 + 1e9c21e
commit 2a2a43a
Show file tree

Hide file tree

Showing 109 changed files with 3,731 additions and 3,763 deletions.
diff --git a/appinfo/info.xml b/appinfo/info.xml
@@ -16,7 +16,7 @@ And in the works for the [coming versions](https://github.com/nextcloud/spreed/m
 
 	]]></description>
 
-	<version>12.0.0-dev.5</version>
+	<version>12.0.0-dev.6</version>
 	<licence>agpl</licence>
 
 	<author>Daniel Calviño Sánchez</author>

diff --git a/appinfo/routes.php b/appinfo/routes.php
@@ -109,7 +109,7 @@
 			'url' => '/api/{apiVersion}/call/{token}',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -118,7 +118,7 @@
 			'url' => '/api/{apiVersion}/call/{token}',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -127,7 +127,7 @@
 			'url' => '/api/{apiVersion}/call/{token}',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -199,31 +199,31 @@
 			'url' => '/api/{apiVersion}/room',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 			],
 		],
 		[
 			'name' => 'Room#getListedRooms',
 			'url' => '/api/{apiVersion}/listed-room',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v3',
+				'apiVersion' => 'v(4)',
 			],
 		],
 		[
 			'name' => 'Room#createRoom',
 			'url' => '/api/{apiVersion}/room',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 			],
 		],
 		[
 			'name' => 'Room#getSingleRoom',
 			'url' => '/api/{apiVersion}/room/{token}',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -232,7 +232,7 @@
 			'url' => '/api/{apiVersion}/room/{token}',
 			'verb' => 'PUT',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -241,7 +241,7 @@
 			'url' => '/api/{apiVersion}/room/{token}',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -250,7 +250,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/public',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -259,7 +259,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/public',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -268,7 +268,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/description',
 			'verb' => 'PUT',
 			'requirements' => [
-				'apiVersion' => 'v3',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -277,7 +277,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/read-only',
 			'verb' => 'PUT',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -286,7 +286,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/listable',
 			'verb' => 'PUT',
 			'requirements' => [
-				'apiVersion' => 'v3',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -295,7 +295,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/password',
 			'verb' => 'PUT',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -304,7 +304,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/participants',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -313,16 +313,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/participants',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
-				'token' => '^[a-z0-9]{4,30}$',
-			],
-		],
-		[
-			'name' => 'Room#removeParticipantFromRoom',
-			'url' => '/api/{apiVersion}/room/{token}/participants',
-			'verb' => 'DELETE',
-			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -331,16 +322,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/participants/self',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
-				'token' => '^[a-z0-9]{4,30}$',
-			],
-		],
-		[
-			'name' => 'Room#removeGuestFromRoom',
-			'url' => '/api/{apiVersion}/room/{token}/participants/guests',
-			'verb' => 'DELETE',
-			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -349,7 +331,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/attendees',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v3',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -358,7 +340,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/participants/active',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -367,7 +349,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/participants/resend-invitations',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v3',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -376,7 +358,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/participants/active',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -385,7 +367,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/moderators',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -394,7 +376,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/moderators',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -403,7 +385,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/favorite',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -412,7 +394,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/favorite',
 			'verb' => 'DELETE',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
@@ -421,7 +403,7 @@
 			'url' => '/api/{apiVersion}/room/{token}/pin/{pin}',
 			'verb' => 'GET',
 			'requirements' => [
-				'apiVersion' => 'v3',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 				'pin' => '^\d{7,32}$',
 			],
@@ -431,27 +413,25 @@
 			'url' => '/api/{apiVersion}/room/{token}/notify',
 			'verb' => 'POST',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
 		[
 			'name' => 'Room#setLobby',
-			'url' => '/api/{apiVersion}/room/{token}/{webinar}/lobby',
+			'url' => '/api/{apiVersion}/room/{token}/webinar/lobby',
 			'verb' => 'PUT',
 			'requirements' => [
-				'apiVersion' => 'v(1|2|3)',
-				'webinar' => 'webinary?',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
 		[
 			'name' => 'Room#setSIPEnabled',
-			'url' => '/api/{apiVersion}/room/{token}/{webinar}/sip',
+			'url' => '/api/{apiVersion}/room/{token}/webinar/sip',
 			'verb' => 'PUT',
 			'requirements' => [
-				'apiVersion' => 'v3',
-				'webinar' => 'webinary?',
+				'apiVersion' => 'v(4)',
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],

diff --git a/docs/call.md b/docs/call.md
@@ -1,8 +1,9 @@
 # Call API
 
-* Base endpoint for API v1 is: `/ocs/v2.php/apps/spreed/api/v1`
-* Base endpoint for API v2 is: `/ocs/v2.php/apps/spreed/api/v2`
-* Base endpoint for API v3 is: `/ocs/v2.php/apps/spreed/api/v3`
+* API v1: 🏁 Removed with API v4
+* API v2: 🏁 Removed with API v4
+* API v3: 🏁 Removed with API v4
+* API v4: Base endpoint `/ocs/v2.php/apps/spreed/api/v4`
 
 ## Get list of connected participants
 
@@ -21,12 +22,11 @@
 
         field | type | API | Description
         ------|------|-----|------------
-        `userId` | string | v1 and v2 only | Is empty for guests
-        `actorType` | string | v3 | Actor type of the attendee (see [Constants - Attendee types](constants.md#attendee-types))
-        `actorId` | string | v3 | The user id, guest random id or email address of the attendee
-        `displayName` | string | v3 | The display name of the attendee
-        `lastPing` | int | * | Timestamp of the last ping of the user (should be used for sorting)
-        `sessionId` | string | * | 512 character long string
+        `actorType` | string | v4 | Actor type of the attendee (see [Constants - Attendee types](constants.md#attendee-types))
+        `actorId` | string | v4 | The user id, guest random id or email address of the attendee
+        `displayName` | string | v4 | The display name of the attendee
+        `lastPing` | int | v4 | Timestamp of the last ping of the user (should be used for sorting)
+        `sessionId` | string | v4 | 512 character long string
 
 ## Join a call
 

diff --git a/docs/capabilities.md b/docs/capabilities.md
@@ -49,11 +49,11 @@ title: Capabilities
 * `config => attachments => folder` - User defined folder where items should be uploaded to
 * `config => conversations => can-create` - Whether the user can create public and group conversations, if not only one-to-one conversations are allowed
 * `force-mute` - "forceMute" signaling messages can be sent to mute other participants.
-* `conversation-v2` - The conversations API v2 is less load heavy and should be used by clients when available. Check the difference in the [Conversation API documentation](conversation.md).
+* `conversation-v2` - ~~The conversations API v2 is less load heavy and should be used by clients when available. Check the difference in the [Conversation API documentation](conversation.md).~~ Replaced by API v4 when `conversation-v4` is set.
 * `chat-reference-id` - an optional referenceId can be sent with a chat message to be able to identify it in parallel get requests to earlier fade out a temporary message
 
 ## 10.1
-* `conversation-v3` - Whether conversations API v3 is available
+* `conversation-v3` - ~~Whether conversations API v3 is available~~ Replaced by API v4 when `conversation-v4` is set.
 * `sip-support` - Whether SIP can be configured and enabled by moderators. The conversations API will come with some new values `sipEnabled` which signals whether this conversation has SIP configured as well as `canEnableSIP` to see if a user can enable it. When it is enabled `attendeePin` will contain the unique dial-in code for this user.
 
 ## 11.0
@@ -69,3 +69,6 @@ title: Capabilities
 * `delete-messages` - Allows to delete chat messages up to 6 hours for your own messages or when being a moderator. On deleting the message text will be replaced and a follow up system message will make sure clients and users update it in their cache and storage.
 * `rich-object-sharing` - Rich objects can be shared to chats. See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob/master/lib/public/RichObjectStrings/Definitions.php) for more details on supported rich objects and required data.
 * `conversation-call-flags` - Whether the room api provides the `callFlag` to tell apart video and audio calls
+
+## 12.0
+* `conversation-v4` - Whether conversations API v4 is available. This also means that v1, v2 and v3 are **not** available anymore. The changes on API v4 allow a user to have multiple sessions in the same conversation on different devices which is incompatible with the data structure that was used by the previous APIs.
diff --git a/docs/constants.md b/docs/constants.md
@@ -19,7 +19,7 @@ title: Constants
 * `1` regular users only, excluding guest app users
 * `2` everyone
 
-### Webinary lobby states
+### Webinar lobby states
 * `0` no lobby
 * `1` lobby for non moderators