Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
->getParticipants()
->getByEmail($user->email);

$internalParticipantUpdateStruct = new InternalParticipantUpdateStruct(ContentSessionScope::EDIT);
$internalParticipantUpdateStruct = new InternalParticipantUpdateStruct(ContentSessionScope::VIEW);
$this->sessionService->updateParticipant($session, $participant, $internalParticipantUpdateStruct);

// Remove participant
Expand Down
8 changes: 4 additions & 4 deletions docs/api/event_reference/collaboration_events.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
description: Events that are triggered when working with collaborative editing feature.
description: Events that are triggered when working with Content sharing feature.

Check notice on line 2 in docs/api/event_reference/collaboration_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/collaboration_events.md#L2 <Ibexa.Passive>

Try to avoid passive tense, when possible.
Raw output
{"message":"Try to avoid passive tense, when possible.","location":{"path":"docs/api/event_reference/collaboration_events.md","range":{"start":{"line":2,"column":26},"end":{"line":2,"column":39}}},"severity":"INFO","code":{"value":"Ibexa.Passive"}}
page_type: reference
month_change: false
---

# Collaboration events
# Content sharing events

You can use the following events to extend the [Collaborative editing LTS Update](collaborative_editing.md):
You can use the following events to extend the [Content sharing LTS Update](content_sharing.md):

## Invitation events

Expand Down Expand Up @@ -48,4 +48,4 @@

| Event | Dispatched by | Description |
|---|---|---|
|<nobr>[`UsersWithPermissionInfoMappedEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Share-Event-UsersWithPermissionInfoMappedEvent.html)</nobr>|`Ibexa\Share\Permission\Mapper\`<br>`UsersWithPermissionInfoMapper` | Allows further filtering of users with permissions for Collaborative editing |
|<nobr>[`UsersWithPermissionInfoMappedEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Share-Event-UsersWithPermissionInfoMappedEvent.html)</nobr>|`Ibexa\Share\Permission\Mapper\`<br>`UsersWithPermissionInfoMapper` | Allows further filtering of users with permissions for Content sharing |

This file was deleted.

This file was deleted.

Binary file not shown.
35 changes: 35 additions & 0 deletions docs/content_management/content_sharing/content_sharing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
description: Content sharing enables users to share content drafts with other users for preview and review.
page_type: landing_page
editions:
- lts-update
month_change: false
---

# Content sharing

With Content sharing [LTS update](editions.md#lts-updates) users can share content drafts created in [[= product_name =]] with other users, streamlining the content review process.

Users can invite both internal and external users to a collaboration session, giving them access for previewing the draft.

This feature also introduces new dashboard tabs for managing shared drafts and joining collaboration sessions easily.

Check warning on line 15 in docs/content_management/content_sharing/content_sharing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_sharing/content_sharing.md#L15 <Ibexa.VerySimply>

Avoid using 'easily'.
Raw output
{"message":"Avoid using 'easily'.","location":{"path":"docs/content_management/content_sharing/content_sharing.md","range":{"start":{"line":15,"column":111},"end":{"line":15,"column":117}}},"severity":"WARNING","code":{"value":"Ibexa.VerySimply"}}

## Getting started

[[= cards([

Check notice on line 19 in docs/content_management/content_sharing/content_sharing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_sharing/content_sharing.md#L19 <Ibexa.SentenceLength>

Keep your sentences to less than 30 words.
Raw output
{"message":"Keep your sentences to less than 30 words.","location":{"path":"docs/content_management/content_sharing/content_sharing.md","range":{"start":{"line":19,"column":5},"end":{"line":19,"column":10}}},"severity":"INFO","code":{"value":"Ibexa.SentenceLength"}}
"content_management/content_sharing/content_sharing_guide",
"content_management/content_sharing/install_content_sharing",
("permissions/policies#content-sharing", "Policies", "Learn about the available Content sharing policies"),
("https://doc.ibexa.co/projects/userguide/en/4.6/content_management/collaborative_editing/", "Content sharing", "Learn about Content sharing feature and its capabilities."),
], columns=2) =]]

## Development

[[= cards([

Check notice on line 28 in docs/content_management/content_sharing/content_sharing.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_sharing/content_sharing.md#L28 <Ibexa.SentenceLength>

Keep your sentences to less than 30 words.
Raw output
{"message":"Keep your sentences to less than 30 words.","location":{"path":"docs/content_management/content_sharing/content_sharing.md","range":{"start":{"line":28,"column":5},"end":{"line":28,"column":10}}},"severity":"INFO","code":{"value":"Ibexa.SentenceLength"}}
"content_management/content_sharing/content_sharing_api",
"api/event_reference/collaboration_events",
("https://doc.ibexa.co/en/4.6/api/rest_api/rest_api_reference/rest_api_reference.html#collaborative-editing", "REST API Reference", "See the available endpoints for Content sharing"),
"content_management/content_sharing/extend_content_sharing",
"search/collaboration_search_reference/collaboration_criteria",
"search/collaboration_search_reference/collaboration_sort_clauses",
], columns=4) =]]
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
description: Use PHP API to manage invitations, sessions, and participants while using collaborative editing feature.
description: Use PHP API to manage invitations, sessions, and participants while using Content sharing feature.

Check notice on line 2 in docs/content_management/content_sharing/content_sharing_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_sharing/content_sharing_api.md#L2 <Ibexa.ByUsing>

Prefer 'by using' or 'with' to plain 'using'.
Raw output
{"message":"Prefer 'by using' or 'with' to plain 'using'.","location":{"path":"docs/content_management/content_sharing/content_sharing_api.md","range":{"start":{"line":2,"column":76},"end":{"line":2,"column":87}}},"severity":"INFO","code":{"value":"Ibexa.ByUsing"}}
editions:
- lts-update
month_change: false
---

# Collaborative editing API
# Content sharing API

[[= product_name =]]'s Collaborative editing API provides two services for managing sessions and invitations, which differ in function:
[[= product_name =]]'s Content sharing API provides two services for managing sessions and invitations, which differ in function:

- [`InvitationServiceInterface`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html) is used to manage collaboration sessions invitations

Expand Down Expand Up @@ -47,7 +47,7 @@
[[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php', 80, 82) =]]
```

To learn more about the available search options, see [Search Criteria](collaboration_criteria.md) and [Sort Clauses](collaboration_sort_clauses.md) for Collaborative editing.
To learn more about the available search options, see [Search Criteria](collaboration_criteria.md) and [Sort Clauses](collaboration_sort_clauses.md) for Content sharing.

### Update session

Expand Down Expand Up @@ -79,20 +79,24 @@
External participant can only be invited using their email address.

The `ContentSessionScope::VIEW` constant defines the type of access granted to a participant.
Available scopes are:
For content collaboration sessions, `VIEW` is the only available scope.
It grants read-only access, used for preview purposes.

- `VIEW` - read-only access, used for preview purposes
- `EDIT` - grants editing capabilities
!!! caution "Deprecated `EDIT` scope"

The `ContentSessionScope::EDIT` constant is deprecated and will be removed in [[= product_name =]] 6.0.
Adding or updating a participant of a content collaboration session with the `EDIT` scope results in an error.

### Get and update participant

You can update participant added to the collaboration session with [`SessionService::updateParticipant()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateParticipant).

The example below updates participant's permissions to allow for editing of shared content, not only previewing.
The example below updates participant's scope.

``` php
[[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php', 111, 118) =]]
```

### Remove participant

You can remove participant from the collaboration session with [`SessionService::removeParticipant()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_removeParticipant):
Expand Down Expand Up @@ -132,13 +136,13 @@

### Create invitation

You can create new invitation for the collaborative session using the [`InvitationService::createInvitation()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_createInvitation) method:
You can create new invitation for the collaboration session using the [`InvitationService::createInvitation()`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_createInvitation) method:

Check notice on line 139 in docs/content_management/content_sharing/content_sharing_api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_sharing/content_sharing_api.md#L139 <Ibexa.ByUsing>

Prefer 'by using' or 'with' to plain 'using'.
Raw output
{"message":"Prefer 'by using' or 'with' to plain 'using'.","location":{"path":"docs/content_management/content_sharing/content_sharing_api.md","range":{"start":{"line":139,"column":53},"end":{"line":139,"column":66}}},"severity":"INFO","code":{"value":"Ibexa.ByUsing"}}

``` php
[[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php', 145, 151) =]]
```

You can use it when [auto-inviting participants](install_collaborative_editing.md#configuration) is not enabled.
You can use it when [auto-inviting participants](install_content_sharing.md#configuration) is not enabled.

### Update invitation

Expand All @@ -164,11 +168,11 @@
[[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php', 135, 141) =]]
```

To learn more about the available search options, see [Search Criteria](collaboration_criteria.md) and [Sort Clauses](collaboration_sort_clauses.md) for Collaborative editing.
To learn more about the available search options, see [Search Criteria](collaboration_criteria.md) and [Sort Clauses](collaboration_sort_clauses.md) for Content sharing.

## Example API usage

Below you can see an example of API usage for Collaborative editing:
Below you can see an example of API usage for Content sharing:

``` php
[[= include_file('code_samples/collaboration/src/Command/ManageSessionsCommand.php') =]]
Expand Down
Loading
Loading