Skip to content

Commit 9cd78af

Browse files
collaboration events described
1 parent 648b40f commit 9cd78af

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
description: Events that are triggered when working with collaborative editing feature.
3+
page_type: reference
4+
month_change: false
5+
---
6+
7+
# Collaboration events
8+
9+
## Invitation events
10+
11+
| Event | Dispatched by | Properties |
12+
|---|---|---|
13+
|`BeforeCreateInvitationEvent`|`InvitationService::createInvitation`|`InvitationCreateStruct $createStruct`<br/>`?InvitationInterface $invitation`|
14+
|`BeforeDeleteInvitationEvent`|`InvitationService::deleteInvitation`|`InvitationInterface $invitation`|
15+
|`BeforeUpdateInvitationEvent`|`InvitationService::updateInvitation`|`InvitationUpdateStruct $createStruct`<br/>`?InvitationInterface $invitation`|
16+
|`CreateInvitationEvent`|`InvitationService::createInvitation`|`InvitationCreateStruct $createStruct`<br/>`?InvitationInterface $invitation`|
17+
|`DeleteInvitationEvent`|`InvitationService::deleteInvitation`|`InvitationInterface $invitation`|
18+
|`UpdateInvitationEvent`|`InvitationService::updateInvitation`|`InvitationUpdateStruct $createStruct`<br/>`?InvitationInterface $invitation`|
19+
20+
## Participant events
21+
22+
| Event | Dispatched by |
23+
|---|---|
24+
|`AddParticipantEvent`|`SessionService::addParticipant`|`SessionInterface $participant`</br>`EntryAddStruct $entryAddStruct`</br>`SessionInterface $parcicipanttResult`|
25+
|`BeforeAddParticipantEvent`|`SessionService::addParticipant`|`SessionInterface $participant`</br>`EntryAddStruct $entryAddStruct`</br>`SessionInterface $parcicipanttResult`|
26+
|`BeforeRemoveParticipantEvent`|`SessionService::removeParticipant`|`SessionInterface $participant`</br>`EntryInterface $entry`</br>`?SessionInterface $participantResult = null`|
27+
|`BeforeUpdateParticipantEvent`|`SessionService::updateParticipant`|`SessionInterface $participant`</br>`ParticipantUpdateStruct $updateStruct`|
28+
|`RemoveParticipantEvent`|`SessionService::removeParticipant`|`SessionInterface $participant`</br>`EntryInterface $entry`</br>`?SessionInterface $participantResult = null`|
29+
|`UpdateParticipantEvent`|`SessionService::updateParticipant`|`SessionInterface $participant`</br>`ParticipantUpdateStruct $updateStruct`|
30+
31+
## Session events
32+
33+
| Event | Dispatched by |
34+
|---|---|---|
35+
|`BeforeCreateSessionEvent`|`SessionService::createSession`|`SessionCreateStruct $createStruct`<br/>`?SessionInterface $session`|
36+
|`BeforeDeleteSessionEvent`|`SessionService::deleteSession`|`SessionInterface $session`|
37+
|`BeforeUpdateSessionEvent`|`SessionService::updateSession`|`SessionUpdateStruct $updateStruct`<br/>`?SessionInterface $session`|
38+
|`CreateSessionEvent`|`SessionService::createSession`|`SessionCreateStruct $createStruct`<br/>`?SessionInterface $session`|
39+
|`DeleteSessionEvent`|`SessionService::deleteSession`|`SessionInterface $session`|
40+
|`JoinSessionEvent`|`SessionService::joinSession`|`SessionInterface $session`|
41+
|`LeaveSessionEvent`|`SessionService::leaveSession`|`SessionInterface $session`|
42+
|`UpdateSessionEvent`|`SessionService::updateSession`|`SessionUpdateStruct $updateStruct`<br/>`?SessionInterface $session`|

0 commit comments

Comments
 (0)