Skip to content

IBX-9737: Collaboration events described in Dev-doc #2893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 22, 2025
Merged

IBX-9737: Collaboration events described in Dev-doc #2893

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9cd78af
collaboration events described
julitafalcondusza Sep 4, 2025
2b6d179
updates
julitafalcondusza Oct 21, 2025
a1ab4c2
Merge branch '5.0' into IBX-9737v2
julitafalcondusza Oct 21, 2025
cbed52d
month change updated
julitafalcondusza Oct 21, 2025
3dd7e32
fixes
julitafalcondusza Oct 22, 2025
6f014a8
fixes after review
julitafalcondusza Oct 22, 2025
f471bb7
properties column removed
julitafalcondusza Oct 22, 2025
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
43 changes: 43 additions & 0 deletions docs/api/event_reference/collaboration_events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
description: Events that are triggered when working with collaborative editing feature.
page_type: reference
month_change: true
---

# Collaboration events

## Invitation events

| Event | Dispatched by | Properties |
|---|---|---|
|[BeforeCreateInvitationEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Event-BeforeCreateInvitationEvent.html)|[InvitationService::createInvitation()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_createInvitation)|`InvitationCreateStruct $createStruct`<br>`?InvitationInterface $invitationResult = null`|

Check failure on line 13 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#L13 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 13, "column": 231}}}, "severity": "ERROR"}
|[BeforeDeleteInvitationEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Event-BeforeDeleteInvitationEvent.html)|[InvitationService::deleteInvitation()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_deleteInvitation)|`InvitationInterface $invitation`|

Check failure on line 14 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#L14 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 14, "column": 231}}}, "severity": "ERROR"}
|[BeforeUpdateInvitationEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Event-BeforeUpdateInvitationEvent.html)|[InvitationService::updateInvitation()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_updateInvitation)|`InvitationInterface $invitation`<br>`InvitationUpdateStruct $updateStruct`<br>`?InvitationInterface $invitationResult = null`|

Check failure on line 15 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#L15 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 15, "column": 231}}}, "severity": "ERROR"}
|[CreateInvitationEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Event-CreateInvitationEvent.html)|[InvitationService::createInvitation()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_createInvitation)|`InvitationCreateStruct $createStruct`<br>`InvitationInterface $invitation`|

Check failure on line 16 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#L16 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 16, "column": 219}}}, "severity": "ERROR"}
|[DeleteInvitationEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Event-DeleteInvitationEvent.html)|[InvitationService::deleteInvitation()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_deleteInvitation)|`InvitationInterface $invitation`|

Check failure on line 17 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#L17 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 17, "column": 219}}}, "severity": "ERROR"}
|[UpdateInvitationEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Event-UpdateInvitationEvent.html)|[InvitationService::updateInvitation()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-InvitationServiceInterface.html#method_updateInvitation)|`InvitationInterface $invitation`<br>`InvitationUpdateStruct $updateStruct`<br>`InvitationInterface $invitationResult`|

Check failure on line 18 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#L18 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 18, "column": 219}}}, "severity": "ERROR"}

## Participant events

| Event | Dispatched by | Properties |
|---|---|---|
|[AddParticipantEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Participant-Event-AddParticipantEvent.html)|[SessionService::addParticipant()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_addParticipant)|`SessionInterface $session`<br>`ParticipantCreateStruct $createStruct`<br>`ParticipantInterface $parcicipant`|

Check failure on line 24 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#L24 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 24, "column": 211}}}, "severity": "ERROR"}
|[BeforeAddParticipantEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Participant-Event-BeforeAddParticipantEvent.html)|[SessionService::addParticipant()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_addParticipant)|`SessionInterface $session`<br>`AbstractParticipantCreateStruct $createStruct`<br>`?ParticipantInterface $participantResult = null`|

Check failure on line 25 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#L25 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 25, "column": 223}}}, "severity": "ERROR"}
|[BeforeRemoveParticipantEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Participant-Event-BeforeRemoveParticipantEvent.html)|[SessionService::removeParticipant()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_removeParticipant)|`SessionInterface $session`<br>`ParticipantInterface $participant`|

Check failure on line 26 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#L26 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 26, "column": 232}}}, "severity": "ERROR"}
|[BeforeUpdateParticipantEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Participant-Event-BeforeUpdateParticipantEvent.html)|[SessionService::updateParticipant()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateParticipant)|`SessionInterface $session`<br>`ParticipantInterface $participant`<br>`AbstractParticipantUpdateStruct $updateStruct`<br>`?ParticipantInterface $participantResult = null`|

Check failure on line 27 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#L27 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 27, "column": 232}}}, "severity": "ERROR"}
|[RemoveParticipantEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Participant-Event-RemoveParticipantEvent.html)|[SessionService::removeParticipant()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_removeParticipant)|`SessionInterface $session`<br>`ParticipantInterface $participant`|

Check failure on line 28 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#L28 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 28, "column": 220}}}, "severity": "ERROR"}
|[UpdateParticipantEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Participant-Event-UpdateParticipantEvent.html)|[SessionService::updateParticipant()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateParticipant)|`SessionInterface $session`<br>`ParticipantInterface $participant`<br>`ParticipantUpdateStruct $updateStruct`<br>`ParticipantInterface $participantResult`|

Check failure on line 29 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#L29 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 29, "column": 220}}}, "severity": "ERROR"}

## Session events

| Event | Dispatched by | Properties |
|---|---|---|
|[BeforeCreateSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-BeforeCreateSessionEvent.html)|[SessionService::createSession()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_createSession)|`AbstractSessionCreateStruct $createStruct`<br>`?SessionInterface $sessionResult = null`|

Check failure on line 35 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#L35 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 35, "column": 216}}}, "severity": "ERROR"}
|[BeforeDeleteSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-BeforeDeleteSessionEvent.html)|[SessionService::deleteSession()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_deleteSession)|`SessionInterface $session`|

Check failure on line 36 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#L36 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 36, "column": 216}}}, "severity": "ERROR"}
|[BeforeUpdateSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-BeforeUpdateSessionEvent.html)|[SessionService::updateSession()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateSession)|`SessionInterface $session`<br>`AbstractSessionUpdateStruct $updateStruct`<br>`?SessionInterface $sessionResult = null`|

Check failure on line 37 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#L37 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 37, "column": 216}}}, "severity": "ERROR"}
|[CreateSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-CreateSessionEvent.html)|[SessionService::createSession()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_createSession)|`AbstractSessionCreateStruct $createStruct`<br>`SessionInterface $sessionResult`|

Check failure on line 38 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#L38 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 38, "column": 204}}}, "severity": "ERROR"}
|[DeleteSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-DeleteSessionEvent.html)|[SessionService::deleteSession()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_deleteSession)|`SessionInterface $session`|

Check failure on line 39 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#L39 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 39, "column": 204}}}, "severity": "ERROR"}
|[JoinSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-JoinSessionEvent.html)|`SessionJoinController::joinAction()`|`SessionInterface $session`|

Check failure on line 40 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#L40 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 40, "column": 60}}}, "severity": "ERROR"}
|[LeaveSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-LeaveSessionEvent.html)|`SessionLeaveController::leaveAction()`|`?SessionInterface $session`|

Check failure on line 41 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#L41 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 41, "column": 61}}}, "severity": "ERROR"}
|[UpdateSessionEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-UpdateSessionEvent.html)|[SessionService::updateSession()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-SessionServiceInterface.html#method_updateSession)|`SessionInterface $session`<br>`AbstractSessionUpdateStruct $updateStruct`<br>`SessionInterface $sessionResult`|

Check failure on line 42 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#L42 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 42, "column": 204}}}, "severity": "ERROR"}
|[SessionPublicPreviewEvent](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Session-Event-SessionPublicPreviewEvent.html)|`SessionPublicPreviewController::previewAction()`|`SessionInterface $session`|

Check failure on line 43 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#L43 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/api/event_reference/collaboration_events.md", "range": {"start": {"line": 43, "column": 69}}}, "severity": "ERROR"}
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ nav:
- Twig Components: api/event_reference/twig_component_events.md
- AI Action events: api/event_reference/ai_action_events.md
- Discounts events: api/event_reference/discounts_events.md
- Collaboration events: api/event_reference/collaboration_events.md
- Other events: api/event_reference/other_events.md
- Administration:
- Administration: administration/administration.md
Expand Down