You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content_management/collaborative_editing/collaborative_editing.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
---
2
2
description: Collaborative editing enables multiple users to work on the same content simultaneously.
3
3
page_type: landing_page
4
+
editions:
5
+
- lts-update
4
6
month_change: true
5
7
---
6
8
@@ -12,7 +14,7 @@ This feature allows multiple users to work together on the same content item in
12
14
Users can invite both internal and external collaborators to a session, giving them access for editing or previewing.
13
15
14
16
Additionaly, they can collaborate using a Real-time collaboration, an advanced part of the collaboration feature, to write and review content in a live mode thanks to CKEditor.
15
-
Real-time collaboration syncs changes instantly and shows user avatars and colored tags to indicate who is editing each part of the content.
17
+
Real-time collaboration syncs changes instantly and shows user avatars and colored tags to indicate who is editing specific part of the Rich Text field.
16
18
17
19
This feature also introduces new dashboard tabs for managing shared drafts and joining collaboration sessions easily.
Copy file name to clipboardExpand all lines: docs/content_management/collaborative_editing/collaborative_editing_api.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,16 @@
1
1
---
2
2
description: Use PHP API to manage invitations and sessions while using collaborative editing feature.
3
-
month_change: false
3
+
editions:
4
+
- lts-update
5
+
month_change: true
4
6
---
5
7
6
8
# Collaborative editing API
7
9
8
10
[[= product_name =]]'s Collaborative editing API provides two services for managing sessions and invitations, which differ in function:
9
11
10
-
-[`InvitationServiceInterface`](../api/php_api/php_api_reference/classes/Ibexa-Contracts-(?)-InvitationServiceInterface.html) is used to request product data
11
-
-[`SessionServiceInterface`](../api/php_api/php_api_reference/classes/Ibexa-Contracts-(?)-SessionServiceInterface.html) is used to modify products
12
+
-[`InvitationServiceInterface`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html) is used to manage collaboration sessions invitations
13
+
-[`SessionServiceInterface`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html) is used to manage collaboration sessions
Copy file name to clipboardExpand all lines: docs/content_management/collaborative_editing/invitation_api.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,17 @@
1
1
---
2
2
description: You can use the PHP API to create new invitation, update existing one, read or delete it.
3
+
editions:
4
+
- lts-update
5
+
month_change: true
3
6
---
4
7
5
8
# Invitation API
6
9
7
-
[`InvitationService`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html) enables you to read, add, update, and remove invitation for collaborative editing session.
10
+
[`InvitationService`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html) enables you to read, add, update, and remove invitation for collaborative editing session.
8
11
9
12
## Create invitation
10
13
11
-
You can create new invitation for the collaborative session using the [`InvitationService::createInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_createInvitation) method:
14
+
You can create new invitation for the collaborative session using the [`InvitationService::createInvitation`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_createInvitation) method:
12
15
13
16
```php
14
17
{
@@ -24,7 +27,7 @@ You can create new invitation for the collaborative session using the [`Invitati
24
27
25
28
## Get invitation by ID
26
29
27
-
You can get an invitation by ID with [`InvitationService::getInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_deleteInvitation):
30
+
You can get an invitation by ID with [`InvitationService::getInvitation`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_getInvitation):
28
31
29
32
```php
30
33
$this->invitationService->getInvitation(1);
@@ -58,21 +61,21 @@ You can select the parameter that you can read from an invitation:
58
61
59
62
## Get invitation by participant
60
63
61
-
You can get an invitation by participant with [`InvitationService::getInvitationByParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_getInvitationByParticipant):
64
+
You can get an invitation by participant with [`InvitationService::getInvitationByParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_getInvitationByParticipant):
You can find an invitation with [`InvitationService::findInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_deleteInvitation).
72
+
You can find an invitation with [`InvitationService::findInvitations`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_findInvitations).
70
73
71
74
To learn more about the available search options, see Search Criteria and Sort Clauses for Collaborative editing.
72
75
73
76
## Update invitation
74
77
75
-
You can update existing invitation with [`InvitationService::updateInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_deleteInvitation):
78
+
You can update existing invitation with [`InvitationService::updateInvitation`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_updateInvitation):
@@ -83,7 +86,7 @@ You can update existing invitation with [`InvitationService::updateInvitation`](
83
86
84
87
## Delete invitation
85
88
86
-
You can delete an invitation with [`InvitationService::deleteInvitation`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-InvitationService.html#method_deleteInvitation):
89
+
You can delete an invitation with [`InvitationService::deleteInvitation`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_deleteInvitation):
Copy file name to clipboardExpand all lines: docs/content_management/collaborative_editing/session_api.md
+31-30Lines changed: 31 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,59 +1,48 @@
1
1
---
2
-
description: You can use the PHP API to create new session, update existing one, find or delete it, and add or remove participants.
2
+
description: You can use the PHP API to create a new session, update an existing one, find or delete it, and add or remove participants.
3
+
editions:
4
+
- lts-update
5
+
month_change: true
3
6
---
4
7
5
8
# Session API
6
9
7
-
[`SessionService`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html) enables you work with the collaborative session, for example, create a new one, update or delete existing one, and add or remove new participants to join collaborative session.
10
+
[`SessionService`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html) enables you work with the collaborative session. You can, for example, create a new one, update or delete an existing one, and add or remove participants taking part in the session.
8
11
9
12
## Create session
10
13
11
-
You can create new collaboration session with given id with [`SessionService::createSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_createSession):
14
+
You can create new collaboration session with [`SessionService::createSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_createSession):
You can return existing collaboration session with [`SessionService::getSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_getSession):
21
+
You can get an existing collaboration session with [`SessionService::getSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_getSession):
19
22
20
-
- using given id:
23
+
- using given id - with [`SessionService::getSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_getSession)
21
24
22
-
```php
23
-
$this->innerService->getSession($id);
24
-
```
25
-
26
-
- using given token:
25
+
- using given token - with [`SessionService::getSessionByToken`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_getSessionByToken)
27
26
28
-
```php
29
-
$this->innerService->getSessionByToken($token);
30
-
```
27
+
## Find sessions
31
28
32
-
- matching the given query:
33
-
34
-
```php
35
-
$this->innerService->findSessions($query);
36
-
```
37
-
38
-
## Find session
39
-
40
-
You can find an existing session with [`SessionService::findSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_findSession) by:
29
+
You can find an existing session with [`SessionService::findSessions`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_findSessions) by:
41
30
42
31
```php
43
32
$this->innerService->findSessions($query);
44
33
```
45
34
46
35
## Update session
47
36
48
-
You can update existing invitation with [`SessionService::updateSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_updateSession):
37
+
You can update existing invitation with [`SessionService::updateSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateSession):
You can delete session with [`SessionService::deleteSession`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_deleteSession):
45
+
You can delete session with [`SessionService::deleteSession`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_deleteSession):
57
46
58
47
```php
59
48
$this->innerService->deleteSession($session);
@@ -63,30 +52,42 @@ You can delete session with [`SessionService::deleteSession`](../../api/php_api/
63
52
64
53
## Add participant
65
54
66
-
You can add participant to the collaboration session with [`SessionService::addParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_addParticipant):
55
+
You can add participant to the collaboration session with [`SessionService::addParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_addParticipant):
$createStruct = new ParticipantCreateStruct($user);
62
+
}
70
63
```
71
64
72
65
## Update participant
73
66
74
-
You can update participant added to the collaboration session with [`SessionService::updateParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_updateParticipant):
67
+
You can update participant added to the collaboration session with [`SessionService::updateParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateParticipant):
You can remove participant from the collaboration session with [`SessionService::removeParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_removeParticipant):
74
+
You can remove participant from the collaboration session with [`SessionService::removeParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_removeParticipant):
You can check the owner of the collaboration session with [`SessionService::isSessionOwner`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceDecorator.html#method_isSessionOwner):
You can check the Owner of the collaboration session with [`SessionService::removeParticipant`](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-SessionService.html#method_removeParticipant):
90
+
You can check the participant of the collaboration session with [`SessionService::isSessionParticipant`](https://doc.ibexa.co/en/latest/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_isSessionParticipant):
0 commit comments