diff --git a/docs/api/event_reference/collaboration_events.md b/docs/api/event_reference/collaboration_events.md new file mode 100644 index 0000000000..ff272f956a --- /dev/null +++ b/docs/api/event_reference/collaboration_events.md @@ -0,0 +1,42 @@ +--- +description: Events that are triggered when working with collaborative editing feature. +page_type: reference +month_change: false +--- + +# Collaboration events + +## Invitation events + +| Event | Dispatched by | Properties | +|---|---|---| +|`BeforeCreateInvitationEvent`|`InvitationService::createInvitation`|`InvitationCreateStruct $createStruct`
`?InvitationInterface $invitation`| +|`BeforeDeleteInvitationEvent`|`InvitationService::deleteInvitation`|`InvitationInterface $invitation`| +|`BeforeUpdateInvitationEvent`|`InvitationService::updateInvitation`|`InvitationUpdateStruct $createStruct`
`?InvitationInterface $invitation`| +|`CreateInvitationEvent`|`InvitationService::createInvitation`|`InvitationCreateStruct $createStruct`
`?InvitationInterface $invitation`| +|`DeleteInvitationEvent`|`InvitationService::deleteInvitation`|`InvitationInterface $invitation`| +|`UpdateInvitationEvent`|`InvitationService::updateInvitation`|`InvitationUpdateStruct $createStruct`
`?InvitationInterface $invitation`| + +## Participant events + +| Event | Dispatched by | +|---|---| +|`AddParticipantEvent`|`SessionService::addParticipant`|`SessionInterface $participant`
`EntryAddStruct $entryAddStruct`
`SessionInterface $parcicipanttResult`| +|`BeforeAddParticipantEvent`|`SessionService::addParticipant`|`SessionInterface $participant`
`EntryAddStruct $entryAddStruct`
`SessionInterface $parcicipanttResult`| +|`BeforeRemoveParticipantEvent`|`SessionService::removeParticipant`|`SessionInterface $participant`
`EntryInterface $entry`
`?SessionInterface $participantResult = null`| +|`BeforeUpdateParticipantEvent`|`SessionService::updateParticipant`|`SessionInterface $participant`
`ParticipantUpdateStruct $updateStruct`| +|`RemoveParticipantEvent`|`SessionService::removeParticipant`|`SessionInterface $participant`
`EntryInterface $entry`
`?SessionInterface $participantResult = null`| +|`UpdateParticipantEvent`|`SessionService::updateParticipant`|`SessionInterface $participant`
`ParticipantUpdateStruct $updateStruct`| + +## Session events + +| Event | Dispatched by | +|---|---|---| +|`BeforeCreateSessionEvent`|`SessionService::createSession`|`SessionCreateStruct $createStruct`
`?SessionInterface $session`| +|`BeforeDeleteSessionEvent`|`SessionService::deleteSession`|`SessionInterface $session`| +|`BeforeUpdateSessionEvent`|`SessionService::updateSession`|`SessionUpdateStruct $updateStruct`
`?SessionInterface $session`| +|`CreateSessionEvent`|`SessionService::createSession`|`SessionCreateStruct $createStruct`
`?SessionInterface $session`| +|`DeleteSessionEvent`|`SessionService::deleteSession`|`SessionInterface $session`| +|`JoinSessionEvent`|`SessionService::joinSession`|`SessionInterface $session`| +|`LeaveSessionEvent`|`SessionService::leaveSession`|`SessionInterface $session`| +|`UpdateSessionEvent`|`SessionService::updateSession`|`SessionUpdateStruct $updateStruct`
`?SessionInterface $session`| \ No newline at end of file