Skip to content
Merged
Changes from all commits
Commits
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
159 changes: 149 additions & 10 deletions developer_manual/app/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,20 @@ Available Events

Here you find an overview of the public events that can be consumed in apps. See their source files for more details.

``\OCA\Files\Event\LoadAdditionalScriptsEvent``
***********************************************

*Available in Nextcloud 17 and later.*

This event is triggered when the files app is rendered. It canb e used to add additional scripts to the files app.

``\OCA\Viewer\Event\LoadViewer``
********************************

*Available in Nextcloud 17 and later.*

This event is triggered whenever the viewer is loaded and extensions should be loaded.

``\OCP\Authentication\Events\LoginFailedEvent``
***********************************************

Expand All @@ -181,13 +195,131 @@ Emitted when the authentication fails, but only if the login name can be associa

Event emitted by apps whenever there was an interaction with another user or contact.

It is an event that allows apps to notify other components about an interaction between two users. This can be used to build better recommendations and suggestions in user interfaces.

Emitters should add at least one identifier (uid, email, federated cloud ID) of the recipient of the interaction.

``\OCP\DirectEditing\RegisterDirectEditorEvent``
************************************************

*Available in Nextcloud 18 and later.*

Event to allow to register the direct editor.

``\OCP\Files\Events\BeforeFileScannedEvent``
********************************************

*Available in Nextcloud 18 and later.*

``\OCP\Files\Events\BeforeFolderScannedEvent``
**********************************************

*Available in Nextcloud 18 and later.*

``\OCP\Files\Events\FileCacheUpdated``
**************************************

*Available in Nextcloud 18 and later.*

``\OCP\Files\Events\FileScannedEvent``
**************************************

*Available in Nextcloud 18 and later.*

``\OCP\Files\Events\FolderScannedEvent``
****************************************

*Available in Nextcloud 18 and later.*

``\OCP\Files\Events\NodeAddedToCache``
**************************************

*Available in Nextcloud 18 and later.*

``\OCP\Files\Events\NodeRemovedFromCache``
******************************************

*Available in Nextcloud 18 and later.*

``\OCP\Group\Events\BeforeGroupCreatedEvent``
*********************************************

*Available in Nextcloud 18 and later.*

``\OCP\Group\Events\BeforeGroupDeletedEvent``
*********************************************

*Available in Nextcloud 18 and later.*

``\OCP\Group\Events\BeforeUserAddedEvent``
******************************************

*Available in Nextcloud 18 and later.*

``\OCP\Group\Events\BeforeUserRemovedEvent``
********************************************

*Available in Nextcloud 18 and later.*

Deprecated in 20.0.0 - it can't be guaranteed that this event is triggered in all case (e.g. for LDAP users this isn't possible)

``\OCP\Group\Events\GroupCreatedEvent``
***************************************

*Available in Nextcloud 18 and later.*

``\OCP\Group\Events\GroupDeletedEvent``
***************************************

*Available in Nextcloud 18 and later.*

``\OCP\Group\Events\UserAddedEvent``
************************************

*Available in Nextcloud 18 and later.*

``\OCP\Group\Events\UserRemovedEvent``
**************************************

*Available in Nextcloud 18 and later.*
``\OCP\Mail\Events\BeforeMessageSent``
**************************************

*Available in Nextcloud 19 and later.*

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

``\OCP\Security\CSP\AddContentSecurityPolicyEvent``
***************************************************

*Available in Nextcloud 17 and later.*

Allows to inject something into the default content policy. This is for example useful when you're injecting Javascript code into a view belonging to another controller and cannot modify its Content-Security-Policy itself. Note that the adjustment is only applied to applications that use AppFramework controllers.

WARNING: Using this API incorrectly may make the instance more insecure. Do think twice before adding whitelisting resources. Please do also note that it is not possible to use the `disallowXYZ` functions.

``\OCP\Security\Events\GenerateSecurePasswordEvent``
****************************************************

*Available in Nextcloud 18 and later.*

``\OCP\Security\Events\ValidatePasswordPolicyEvent``
****************************************************

*Available in Nextcloud 18 and later.*

``\OCP\Security\FeaturePolicy\AddFeaturePolicyEvent``
****************************************************

*Available in Nextcloud 17 and later.*

Event that allows to register a feature policy header to a request.

``\OCP\Share\Events\ShareCreatedEvent``
*******************************************

*Available in Nextcloud 18 and later.*

``\OCP\Share\Events\VerifyMountPointEvent``
*******************************************

Expand All @@ -203,10 +335,10 @@ Emitted before a user is logged in via remember-me cookies.
``\OCP\User\Events\UserLoggedInWithCookieEvent``
************************************************

Emitted when a user has been succesfully logged in via remember-me cookies.

*Available in Nextcloud 18 and later.*

Emitted when a user has been succesfully logged in via remember-me cookies.

``\OCP\User\Events\BeforePasswordUpdatedEvent``
***********************************************

Expand Down Expand Up @@ -240,15 +372,11 @@ Emitted when a new user has been created on the back-end.

*Available in Nextcloud 18 and later.*

Emitted before a user is logged out.

``\OCP\User\Events\UserDeletedEvent``
*************************************

*Available in Nextcloud 18 and later.*

Emitted when a user has been logged out successfully.

``\OCP\User\Events\BeforeUserLoggedInEvent``
********************************************

Expand All @@ -259,6 +387,8 @@ Emitted when a user has been logged out successfully.

*Available in Nextcloud 18 and later.*

Emitted before a user is logged out.

``\OCP\User\Events\CreateUserEvent``
************************************

Expand All @@ -284,13 +414,22 @@ Emitted when a user has been logged out successfully.

*Available in Nextcloud 18 and later.*

``\OCP\Security\CSP\AddContentSecurityPolicyEvent``
***************************************************
Emitted when a user has been logged out successfully.

*Available in Nextcloud 17 and later.*
``\OCP\WorkflowEngine\RegisterChecksEvent``
***************************************

*Available in Nextcloud 18 and later.*

``\OCP\WorkflowEngine\RegisterEntitiesEvent``
***************************************

This event is emitted so apps can modify the CSP provided by nextcloud. For example if more domains can be used to connect to. Added in Nextcloud 17.
*Available in Nextcloud 18 and later.*

``\OCP\WorkflowEngine\RegisterOperationsEvent``
***************************************

*Available in Nextcloud 18 and later.*

Symfony event dispatcher
------------------------
Expand Down