Skip to content

Commit ade4ad0

Browse files
CopilotKamilSznajdrowicz
authored andcommitted
Add collaboration policies template based on PolicyProvider.php structure
Co-authored-by: KamilSznajdrowicz <[email protected]>
1 parent e427140 commit ade4ad0

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
description: Collaboration policies template based on PolicyProvider.php from ibexa/share
3+
page_type: reference
4+
---
5+
6+
# Collaboration Policies Template
7+
8+
This template documents the collaboration policies as defined in the PolicyProvider.php from ibexa/share repository.
9+
10+
The Collaboration bundle allows multiple people to work together on the same content. Teams can invite colleagues and external partners to join collaboration sessions where they can edit content in real-time or preview it before publication.
11+
12+
## Available policies
13+
14+
### Collaboration
15+
16+
The collaboration policies control various aspects of collaborative content editing, session management, invitations, and sharing.
17+
18+
| Module | Function | Effect | Possible limitations |
19+
|--------|----------|--------|---------------------|
20+
| <nobr>`collaboration`</nobr> | <nobr>`create_session`</nobr> | Create session - Create new collaboration sessions for content items | [Content type](limitation_reference.md#content-type-limitation)</br>[Section](limitation_reference.md#section-limitation)</br>[Owner](limitation_reference.md#owner-limitation)</br>[Location](limitation_reference.md#location-limitation)</br>[Subtree](limitation_reference.md#subtree-limitation) |
21+
| | <nobr>`view_session`</nobr> | View session - View collaboration sessions and their details | [Content type](limitation_reference.md#content-type-limitation)</br>[Section](limitation_reference.md#section-limitation)</br>[Owner](limitation_reference.md#owner-limitation) |
22+
| | <nobr>`edit_session`</nobr> | Edit session - Modify collaboration session settings and permissions | [Owner](limitation_reference.md#owner-limitation) |
23+
| | <nobr>`delete_session`</nobr> | Delete session - Delete collaboration sessions | [Owner](limitation_reference.md#owner-limitation) |
24+
| | <nobr>`join_session`</nobr> | Join session - Join existing collaboration sessions | [Content type](limitation_reference.md#content-type-limitation)</br>[Section](limitation_reference.md#section-limitation) |
25+
| | <nobr>`leave_session`</nobr> | Leave session - Leave collaboration sessions | None |
26+
| | <nobr>`invite_user`</nobr> | Invite user - Create and send invitations to users for collaboration sessions | [Content type](limitation_reference.md#content-type-limitation)</br>[Owner](limitation_reference.md#owner-limitation) |
27+
| | <nobr>`view_invitation`</nobr> | View invitation - View sent and received invitations | [Owner](limitation_reference.md#owner-limitation) |
28+
| | <nobr>`update_invitation`</nobr> | Update invitation - Modify invitation permissions (edit/preview access) | [Owner](limitation_reference.md#owner-limitation) |
29+
| | <nobr>`revoke_invitation`</nobr> | Revoke invitation - Revoke or delete invitations | [Owner](limitation_reference.md#owner-limitation) |
30+
| | <nobr>`accept_invitation`</nobr> | Accept invitation - Accept invitations to join collaboration sessions | None |
31+
| | <nobr>`decline_invitation`</nobr> | Decline invitation - Decline invitations to join collaboration sessions | None |
32+
| | <nobr>`preview_content`</nobr> | Preview content - Preview content in collaboration sessions | [Content type](limitation_reference.md#content-type-limitation)</br>[Section](limitation_reference.md#section-limitation)</br>[Location](limitation_reference.md#location-limitation)</br>[Subtree](limitation_reference.md#subtree-limitation) |
33+
| | <nobr>`edit_content`</nobr> | Edit content - Edit content collaboratively in real-time | [Content type](limitation_reference.md#content-type-limitation)</br>[Section](limitation_reference.md#section-limitation)</br>[Owner](limitation_reference.md#owner-limitation)</br>[Location](limitation_reference.md#location-limitation)</br>[Subtree](limitation_reference.md#subtree-limitation)</br>[Field Group](limitation_reference.md#field-group-limitation) |
34+
| | <nobr>`comment`</nobr> | Comment - Add comments and feedback in collaboration sessions | [Content type](limitation_reference.md#content-type-limitation)</br>[Section](limitation_reference.md#section-limitation) |
35+
| | <nobr>`create_link`</nobr> | Create link - Create shareable links for collaboration sessions | [Content type](limitation_reference.md#content-type-limitation)</br>[Owner](limitation_reference.md#owner-limitation) |
36+
| | <nobr>`view_link`</nobr> | View link - View and copy shareable links | [Owner](limitation_reference.md#owner-limitation) |
37+
| | <nobr>`manage_link`</nobr> | Manage link - Configure link settings (expiration, permissions) | [Owner](limitation_reference.md#owner-limitation) |
38+
| | <nobr>`revoke_link`</nobr> | Revoke link - Revoke or disable shareable links | [Owner](limitation_reference.md#owner-limitation) |
39+
40+
## Policy Details
41+
42+
### Session Management Policies
43+
44+
- **collaboration/create_session**: Allows creating new collaboration sessions for content items
45+
- **collaboration/view_session**: Allows viewing collaboration sessions and their details
46+
- **collaboration/edit_session**: Allows modifying collaboration session settings and permissions
47+
- **collaboration/delete_session**: Allows deleting collaboration sessions
48+
- **collaboration/join_session**: Allows joining existing collaboration sessions
49+
- **collaboration/leave_session**: Allows leaving collaboration sessions
50+
51+
### Invitation Management Policies
52+
53+
- **collaboration/invite_user**: Allows creating and sending invitations to users for collaboration sessions
54+
- **collaboration/view_invitation**: Allows viewing sent and received invitations
55+
- **collaboration/update_invitation**: Allows modifying invitation permissions (edit/preview access)
56+
- **collaboration/revoke_invitation**: Allows revoking or deleting invitations
57+
- **collaboration/accept_invitation**: Allows accepting invitations to join collaboration sessions
58+
- **collaboration/decline_invitation**: Allows declining invitations to join collaboration sessions
59+
60+
### Content Collaboration Policies
61+
62+
- **collaboration/preview_content**: Allows previewing content in collaboration sessions
63+
- **collaboration/edit_content**: Allows editing content collaboratively in real-time
64+
- **collaboration/comment**: Allows adding comments and feedback in collaboration sessions
65+
66+
### Sharing and Link Policies
67+
68+
- **collaboration/create_link**: Allows creating shareable links for collaboration sessions
69+
- **collaboration/view_link**: Allows viewing and copying shareable links
70+
- **collaboration/manage_link**: Allows configuring link settings (expiration, permissions)
71+
- **collaboration/revoke_link**: Allows revoking or disabling shareable links
72+
73+
## Related Documentation
74+
75+
- [Policies](policies.md) - Main policies reference
76+
- [Custom policies](custom_policies.md) - How to create custom policies
77+
- [Limitation reference](limitation_reference.md) - Available limitations
78+
- [Permissions](permissions.md) - Overview of the permissions system

0 commit comments

Comments
 (0)