Skip to content

Commit 41c55a5

Browse files
committed
chore: Update list of OCP events
Signed-off-by: provokateurin <[email protected]>
1 parent dd5b8f0 commit 41c55a5

File tree

1 file changed

+109
-8
lines changed

1 file changed

+109
-8
lines changed

developer_manual/basics/_available_events_ocp.rst

Lines changed: 109 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,42 @@ Emitted when the authentication fails, but only if the login name can be associa
127127
Dispatched before Sabre is loaded when accessing public webdav endpoints
128128
This can be used to inject a Sabre plugin for example
129129

130+
``OCP\Calendar\Events\CalendarObjectCreatedEvent``
131+
**************************************************
132+
133+
.. versionadded:: 32
134+
135+
136+
``OCP\Calendar\Events\CalendarObjectDeletedEvent``
137+
**************************************************
138+
139+
.. versionadded:: 32
140+
141+
142+
``OCP\Calendar\Events\CalendarObjectMovedEvent``
143+
************************************************
144+
145+
.. versionadded:: 32
146+
147+
148+
``OCP\Calendar\Events\CalendarObjectMovedToTrashEvent``
149+
*******************************************************
150+
151+
.. versionadded:: 32
152+
153+
154+
``OCP\Calendar\Events\CalendarObjectRestoredEvent``
155+
***************************************************
156+
157+
.. versionadded:: 32
158+
159+
160+
``OCP\Calendar\Events\CalendarObjectUpdatedEvent``
161+
**************************************************
162+
163+
.. versionadded:: 32
164+
165+
130166
``OCP\Collaboration\AutoComplete\AutoCompleteEvent``
131167
****************************************************
132168

@@ -244,7 +280,7 @@ Event to allow to register the direct editor.
244280
.. versionadded:: 18
245281

246282
Class GenericEvent
247-
convenience reimplementation of \Symfony\Component\GenericEvent against
283+
convenience re-implementation of \Symfony\Component\GenericEvent against
248284
\OCP\EventDispatcher\Event
249285

250286
``OCP\Federation\Events\TrustedServerRemovedEvent``
@@ -294,6 +330,27 @@ Event for when a new entry gets added to the cache
294330

295331
Event for when an existing entry in the cache gets updated
296332

333+
``OCP\Files\Config\Event\UserMountAddedEvent``
334+
**********************************************
335+
336+
.. versionadded:: 31
337+
338+
Event emitted when a user mount was added.
339+
340+
``OCP\Files\Config\Event\UserMountRemovedEvent``
341+
************************************************
342+
343+
.. versionadded:: 31
344+
345+
Event emitted when a user mount was removed.
346+
347+
``OCP\Files\Config\Event\UserMountUpdatedEvent``
348+
************************************************
349+
350+
.. versionadded:: 31
351+
352+
Event emitted when a user mount was moved.
353+
297354
``OCP\Files\Events\BeforeDirectFileDownloadEvent``
298355
**************************************************
299356

@@ -308,6 +365,13 @@ directly.
308365
.. versionadded:: 18
309366

310367

368+
``OCP\Files\Events\BeforeFileSystemSetupEvent``
369+
***********************************************
370+
371+
.. versionadded:: 31
372+
373+
Event triggered before the file system is setup
374+
311375
``OCP\Files\Events\BeforeFolderScannedEvent``
312376
*********************************************
313377

@@ -319,6 +383,9 @@ directly.
319383

320384
.. versionadded:: 25
321385

386+
This event is triggered before a archive is created when a user requested
387+
downloading a folder or multiple files.
388+
By setting `successful` to false the tar creation can be aborted and the download denied.
322389

323390
``OCP\Files\Events\FileCacheUpdated``
324391
*************************************
@@ -599,6 +666,12 @@ Even for when a log item is being logged
599666

600667
Emitted before a system mail is sent. It can be used to alter the message.
601668

669+
``OCP\Navigation\Events\LoadAdditionalEntriesEvent``
670+
****************************************************
671+
672+
.. versionadded:: 31
673+
674+
602675
``OCP\OCM\Events\ResourceTypeRegisterEvent``
603676
********************************************
604677

@@ -615,6 +688,9 @@ them in the OCM provider list and capability
615688
.. versionchanged:: 28.0.0
616689
the constructor arguments ``$width``, ``$height``, ``$crop`` and ``$mode`` are no longer nullable.
617690

691+
.. versionchanged:: 31.0.0
692+
the constructor arguments ``$mimeType`` was added
693+
618694
Emitted before a file preview is being fetched.
619695
It can be used to block preview rendering by throwing a ``OCP\Files\NotFoundException``
620696

@@ -651,10 +727,7 @@ that it is not possible to use the `disallowXYZ` functions.
651727

652728
.. versionadded:: 18
653729

654-
Event to request a secure password to be generated.
655-
656-
Since Nextcloud 31 this event also provides a ``getContext`` method
657-
allowing to apply different rules for different password context like account passwords or share passwords.
730+
Event to request a secure password to be generated
658731

659732
``OCP\Security\Events\ValidatePasswordPolicyEvent``
660733
***************************************************
@@ -665,9 +738,6 @@ This event can be emitted to request a validation of a password.
665738
If a password policy app is installed and the password
666739
is invalid, an `\OCP\HintException` will be thrown.
667740

668-
Since Nextcloud 31 this event also provides a ``getContext`` method
669-
allowing to apply different rules for different password context like account passwords or share passwords.
670-
671741
``OCP\Security\FeaturePolicy\AddFeaturePolicyEvent``
672742
****************************************************
673743

@@ -773,6 +843,16 @@ Class MapperEvent
773843

774844
Class SystemTagsEntityEvent
775845

846+
``OCP\TaskProcessing\Events\GetTaskProcessingProvidersEvent``
847+
*************************************************************
848+
849+
.. versionadded:: 32
850+
851+
Event dispatched by the server to collect Task Processing Providers
852+
and custom Task Types from listeners (like AppAPI).
853+
Listeners should add their providers and task types using the
854+
addProvider() and addTaskType() methods.
855+
776856
``OCP\TaskProcessing\Events\TaskFailedEvent``
777857
*********************************************
778858

@@ -829,6 +909,13 @@ Emitted before a new user is created on the back-end.
829909
.. versionadded:: 18
830910

831911

912+
``OCP\User\Events\BeforeUserIdUnassignedEvent``
913+
***********************************************
914+
915+
.. versionadded:: 31
916+
917+
Emitted before removing the mapping between an external user and an internal userid
918+
832919
``OCP\User\Events\BeforeUserLoggedInEvent``
833920
*******************************************
834921

@@ -922,6 +1009,20 @@ Emitted when a new user has been created on the back-end.
9221009
.. versionadded:: 28
9231010

9241011

1012+
``OCP\User\Events\UserIdAssignedEvent``
1013+
***************************************
1014+
1015+
.. versionadded:: 31
1016+
1017+
Emitted by backends (like user_ldap) when a user created externally is mapped for the first time and assigned a userid
1018+
1019+
``OCP\User\Events\UserIdUnassignedEvent``
1020+
*****************************************
1021+
1022+
.. versionadded:: 31
1023+
1024+
Emitted after removing the mapping between an external user and an internal userid
1025+
9251026
``OCP\User\Events\UserLiveStatusEvent``
9261027
***************************************
9271028

0 commit comments

Comments
 (0)