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

Draft
wants to merge 1 commit into
base: 5.0
Choose a base branch
from
Draft

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 42 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,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`<br/>`?InvitationInterface $invitation`|
|`BeforeDeleteInvitationEvent`|`InvitationService::deleteInvitation`|`InvitationInterface $invitation`|
|`BeforeUpdateInvitationEvent`|`InvitationService::updateInvitation`|`InvitationUpdateStruct $createStruct`<br/>`?InvitationInterface $invitation`|
|`CreateInvitationEvent`|`InvitationService::createInvitation`|`InvitationCreateStruct $createStruct`<br/>`?InvitationInterface $invitation`|
|`DeleteInvitationEvent`|`InvitationService::deleteInvitation`|`InvitationInterface $invitation`|
|`UpdateInvitationEvent`|`InvitationService::updateInvitation`|`InvitationUpdateStruct $createStruct`<br/>`?InvitationInterface $invitation`|

## Participant events

| Event | Dispatched by |
|---|---|
|`AddParticipantEvent`|`SessionService::addParticipant`|`SessionInterface $participant`</br>`EntryAddStruct $entryAddStruct`</br>`SessionInterface $parcicipanttResult`|
|`BeforeAddParticipantEvent`|`SessionService::addParticipant`|`SessionInterface $participant`</br>`EntryAddStruct $entryAddStruct`</br>`SessionInterface $parcicipanttResult`|
|`BeforeRemoveParticipantEvent`|`SessionService::removeParticipant`|`SessionInterface $participant`</br>`EntryInterface $entry`</br>`?SessionInterface $participantResult = null`|
|`BeforeUpdateParticipantEvent`|`SessionService::updateParticipant`|`SessionInterface $participant`</br>`ParticipantUpdateStruct $updateStruct`|
|`RemoveParticipantEvent`|`SessionService::removeParticipant`|`SessionInterface $participant`</br>`EntryInterface $entry`</br>`?SessionInterface $participantResult = null`|
|`UpdateParticipantEvent`|`SessionService::updateParticipant`|`SessionInterface $participant`</br>`ParticipantUpdateStruct $updateStruct`|

## Session events

| Event | Dispatched by |
|---|---|---|
|`BeforeCreateSessionEvent`|`SessionService::createSession`|`SessionCreateStruct $createStruct`<br/>`?SessionInterface $session`|
|`BeforeDeleteSessionEvent`|`SessionService::deleteSession`|`SessionInterface $session`|
|`BeforeUpdateSessionEvent`|`SessionService::updateSession`|`SessionUpdateStruct $updateStruct`<br/>`?SessionInterface $session`|
|`CreateSessionEvent`|`SessionService::createSession`|`SessionCreateStruct $createStruct`<br/>`?SessionInterface $session`|
|`DeleteSessionEvent`|`SessionService::deleteSession`|`SessionInterface $session`|
|`JoinSessionEvent`|`SessionService::joinSession`|`SessionInterface $session`|
|`LeaveSessionEvent`|`SessionService::leaveSession`|`SessionInterface $session`|
|`UpdateSessionEvent`|`SessionService::updateSession`|`SessionUpdateStruct $updateStruct`<br/>`?SessionInterface $session`|
Loading