diff --git a/developer_manual/basics/_available_events_ocp.rst b/developer_manual/basics/_available_events_ocp.rst index 11cbf60a5..e118b3460 100644 --- a/developer_manual/basics/_available_events_ocp.rst +++ b/developer_manual/basics/_available_events_ocp.rst @@ -1,6 +1,56 @@ .. This file is generated by nextcloud-ocp-events. .. Always change the source file. +``OCP\Accounts\UserUpdatedEvent`` +********************************* + +.. versionadded:: 28 + +This event is triggered when the account data of a user was updated. + +``OCP\App\Events\AppDisableEvent`` +********************************** + +.. versionadded:: 27 + +This event is triggered when an app is disabled. + +``OCP\App\Events\AppEnableEvent`` +********************************* + +.. versionadded:: 27 + +This event is triggered when an app is enabled. + +``OCP\App\Events\AppUpdateEvent`` +********************************* + +.. versionadded:: 27 + +This event is triggered when an app is updated. + +``OCP\App\ManagerEvent`` +************************ + +.. versionadded:: 9 + +Class ManagerEvent + +``OCP\AppFramework\Http\Events\BeforeLoginTemplateRenderedEvent`` +***************************************************************** + +.. versionadded:: 28 + +Emitted before the rendering step of the login TemplateResponse. + +``OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent`` +************************************************************ + +.. versionadded:: 20 + +Emitted before the rendering step of each TemplateResponse. The event holds a +flag that specifies if an user is logged in. + ``OCP\Authentication\Events\AnyLoginFailedEvent`` ************************************************* @@ -21,10 +71,10 @@ Emitted when the authentication fails, but only if the login name can be associa .. versionadded:: 15 -``OCP\Authentication\TwoFactorAuth\TwoFactorProviderDisabled`` -************************************************************** +``OCP\Authentication\TwoFactorAuth\TwoFactorProviderChallengeFailed`` +********************************************************************* -.. versionadded:: 20 +.. versionadded:: 28 ``OCP\Authentication\TwoFactorAuth\TwoFactorProviderChallengePassed`` @@ -33,10 +83,10 @@ Emitted when the authentication fails, but only if the login name can be associa .. versionadded:: 28 -``OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserEnabled`` -******************************************************************** +``OCP\Authentication\TwoFactorAuth\TwoFactorProviderDisabled`` +************************************************************** -.. versionadded:: 22 +.. versionadded:: 20 ``OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserDisabled`` @@ -45,246 +95,37 @@ Emitted when the authentication fails, but only if the login name can be associa .. versionadded:: 22 +``OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserEnabled`` +******************************************************************** + +.. versionadded:: 22 + + ``OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserRegistered`` *********************************************************************** .. versionadded:: 28 -``OCP\Authentication\TwoFactorAuth\TwoFactorProviderUserDeleted`` -***************************************************************** - -.. versionadded:: 28 - - -``OCP\Authentication\TwoFactorAuth\TwoFactorProviderChallengeFailed`` -********************************************************************* - -.. versionadded:: 28 - - ``OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserUnregistered`` ************************************************************************* .. versionadded:: 28 -``OCP\Profile\BeforeTemplateRenderedEvent`` -******************************************* - -.. versionadded:: 25 - -Emitted before the rendering step of the public profile page happens. - -``OCP\Share\Events\ShareDeletedEvent`` -************************************** - -.. versionadded:: 21 - - -``OCP\Share\Events\ShareDeletedFromSelfEvent`` -********************************************** - -.. versionadded:: 28 - - -``OCP\Share\Events\BeforeShareCreatedEvent`` -******************************************** - -.. versionadded:: 28 - - -``OCP\Share\Events\BeforeShareDeletedEvent`` -******************************************** - -.. versionadded:: 28 - - -``OCP\Share\Events\ShareCreatedEvent`` -************************************** - -.. versionadded:: 18 - - -``OCP\Share\Events\VerifyMountPointEvent`` -****************************************** - -.. versionadded:: 19 - - -``OCP\Share\Events\ShareAcceptedEvent`` -*************************************** - -.. versionadded:: 28 - - -``OCP\AppFramework\Http\Events\BeforeLoginTemplateRenderedEvent`` +``OCP\Authentication\TwoFactorAuth\TwoFactorProviderUserDeleted`` ***************************************************************** .. versionadded:: 28 -Emitted before the rendering step of the login TemplateResponse. -``OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent`` -************************************************************ +``OCP\BeforeSabrePubliclyLoadedEvent`` +************************************** -.. versionadded:: 20 - -Emitted before the rendering step of each TemplateResponse. The event holds a -flag that specifies if an user is logged in. - -``OCP\FilesMetadata\Event\MetadataBackgroundEvent`` -*************************************************** - -.. versionadded:: 28 - -MetadataBackgroundEvent is an event similar to MetadataLiveEvent but dispatched -on a background thread instead of live thread. Meaning there is no limit to -the time required for the generation of your metadata. - -``OCP\FilesMetadata\Event\MetadataNamedEvent`` -********************************************** - -.. versionadded:: 28 - -MetadataNamedEvent is an event similar to MetadataBackgroundEvent completed with a target name, -used to limit the refresh of metadata only listeners capable of filtering themselves out. -Meaning that when using this event, your app must implement a filter on the event's registered -name returned by getName() - -This event is mostly triggered when a registered name is added to the files scan - i.e. ./occ files:scan --generate-metadata [name] - -``OCP\FilesMetadata\Event\MetadataLiveEvent`` -********************************************* - -.. versionadded:: 28 - -MetadataLiveEvent is an event initiated when a file is created or updated. -The app contains the Node related to the created/updated file, and a FilesMetadata that already -contains the currently known metadata. - -Setting new metadata, or modifying already existing metadata with different value, will trigger -the save of the metadata in the database. - -``OCP\App\Events\AppUpdateEvent`` -********************************* - -.. versionadded:: 27 - -This event is triggered when an app is updated. - -``OCP\App\Events\AppEnableEvent`` -********************************* - -.. versionadded:: 27 - -This event is triggered when an app is enabled. - -``OCP\App\Events\AppDisableEvent`` -********************************** - -.. versionadded:: 27 - -This event is triggered when an app is disabled. - -``OCP\App\ManagerEvent`` -************************ - -.. versionadded:: 9 - -Class ManagerEvent - -``OCP\TextToImage\Events\TaskFailedEvent`` -****************************************** - -.. versionadded:: 28 - - -``OCP\TextToImage\Events\TaskSuccessfulEvent`` -********************************************** - -.. versionadded:: 28 - - -``OCP\Contacts\Events\ContactInteractedWithEvent`` -************************************************** - -.. versionadded:: 19 - -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\WorkflowEngine\Events\RegisterOperationsEvent`` -***************************************************** - -.. versionadded:: 18 - - -``OCP\WorkflowEngine\Events\RegisterChecksEvent`` -************************************************* - -.. versionadded:: 18 - - -``OCP\WorkflowEngine\Events\LoadSettingsScriptsEvent`` -****************************************************** - -.. versionadded:: 20 - -Emitted when the workflow engine settings page is loaded. - -``OCP\WorkflowEngine\Events\RegisterEntitiesEvent`` -*************************************************** - -.. versionadded:: 18 - - -``OCP\Federation\Events\TrustedServerRemovedEvent`` -*************************************************** - -.. versionadded:: 25 - - -``OCP\SabrePluginEvent`` -************************ - -.. versionadded:: 8.2 - - -``OCP\Mail\Events\BeforeMessageSent`` -************************************* - -.. versionadded:: 19 - -Emitted before a system mail is sent. It can be used to alter the message. - -``OCP\Settings\Events\DeclarativeSettingsRegisterFormEvent`` -************************************************************ - -.. versionadded:: 29 - - -``OCP\Settings\Events\DeclarativeSettingsSetValueEvent`` -******************************************************** - -.. versionadded:: 29 - - -``OCP\Settings\Events\DeclarativeSettingsGetValueEvent`` -******************************************************** - -.. versionadded:: 29 - - -``OCP\Collaboration\AutoComplete\AutoCompleteFilterEvent`` -********************************************************** - -.. versionadded:: 28 +.. versionadded:: 26 +Dispatched before Sabre is loaded when accessing public webdav endpoints +This can be used to inject a Sabre plugin for example ``OCP\Collaboration\AutoComplete\AutoCompleteEvent`` **************************************************** @@ -292,14 +133,11 @@ Emitted before a system mail is sent. It can be used to alter the message. .. versionadded:: 16 -``OCP\Collaboration\Resources\LoadAdditionalScriptsEvent`` +``OCP\Collaboration\AutoComplete\AutoCompleteFilterEvent`` ********************************************************** -.. versionadded:: 25 +.. versionadded:: 28 -This event is used by apps to register their own frontend scripts for integrating -projects in their app. Apps also need to dispatch the event in order to load -scripts during page load ``OCP\Collaboration\Reference\RenderReferenceEvent`` **************************************************** @@ -310,6 +148,15 @@ Event emitted when apps might render references like link previews or smart pick This can be used to inject scripts for extending that. Further details can be found in the :ref:`Reference providers` deep dive. +``OCP\Collaboration\Resources\LoadAdditionalScriptsEvent`` +********************************************************** + +.. versionadded:: 25 + +This event is used by apps to register their own frontend scripts for integrating +projects in their app. Apps also need to dispatch the event in order to load +scripts during page load + ``OCP\Comments\CommentsEntityEvent`` ************************************ @@ -327,26 +174,90 @@ Class CommentsEntityEvent Class CommentsEvent -``OCP\Accounts\UserUpdatedEvent`` -********************************* +``OCP\Config\BeforePreferenceDeletedEvent`` +******************************************* + +.. versionadded:: 25 + + +``OCP\Config\BeforePreferenceSetEvent`` +*************************************** + +.. versionadded:: 25 + + +``OCP\Console\ConsoleEvent`` +**************************** + +.. versionadded:: 9 + +Class ConsoleEvent + +``OCP\Contacts\Events\ContactInteractedWithEvent`` +************************************************** + +.. versionadded:: 19 + +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\DB\Events\AddMissingColumnsEvent`` +**************************************** .. versionadded:: 28 -This event is triggered when the account data of a user was updated. +Event to allow apps to register information about missing database columns +This event will be dispatched for checking on the admin settings and when running +occ db:add-missing-columns which will then create those columns -``OCP\Files\Cache\CacheEntryRemovedEvent`` -****************************************** +``OCP\DB\Events\AddMissingIndicesEvent`` +**************************************** -.. versionadded:: 21 +.. versionadded:: 28 -Event for when an existing entry in the cache gets removed +Event to allow apps to register information about missing database indices +This event will be dispatched for checking on the admin settings and when running +occ db:add-missing-indices which will then create those indices -``OCP\Files\Cache\CacheUpdateEvent`` +``OCP\DB\Events\AddMissingPrimaryKeyEvent`` +******************************************* + +.. versionadded:: 28 + +Event to allow apps to register information about missing database primary keys +This event will be dispatched for checking on the admin settings and when running +occ db:add-missing-primary-keys which will then create those keys + +``OCP\DirectEditing\RegisterDirectEditorEvent`` +*********************************************** + +.. versionadded:: 18 + +Event to allow to register the direct editor. + +``OCP\EventDispatcher\GenericEvent`` ************************************ -.. versionadded:: 16 +.. versionadded:: 18 + +Class GenericEvent +convenience reimplementation of \Symfony\Component\GenericEvent against +\OCP\EventDispatcher\Event + +``OCP\Federation\Events\TrustedServerRemovedEvent`` +*************************************************** + +.. versionadded:: 25 + + +``OCP\Files\Cache\AbstractCacheEvent`` +************************************** + +.. versionadded:: 22 -Event for when an existing entry in the cache gets updated ``OCP\Files\Cache\CacheEntryInsertedEvent`` ******************************************* @@ -355,6 +266,13 @@ Event for when an existing entry in the cache gets updated Event for when an existing entry in the cache gets inserted +``OCP\Files\Cache\CacheEntryRemovedEvent`` +****************************************** + +.. versionadded:: 21 + +Event for when an existing entry in the cache gets removed + ``OCP\Files\Cache\CacheEntryUpdatedEvent`` ****************************************** @@ -362,12 +280,6 @@ Event for when an existing entry in the cache gets inserted Event for when an existing entry in the cache gets updated -``OCP\Files\Cache\AbstractCacheEvent`` -************************************** - -.. versionadded:: 22 - - ``OCP\Files\Cache\CacheInsertEvent`` ************************************ @@ -375,10 +287,43 @@ Event for when an existing entry in the cache gets updated Event for when a new entry gets added to the cache -``OCP\Files\Events\NodeRemovedFromFavorite`` -******************************************** +``OCP\Files\Cache\CacheUpdateEvent`` +************************************ -.. versionadded:: 28 +.. versionadded:: 16 + +Event for when an existing entry in the cache gets updated + +``OCP\Files\Events\BeforeDirectFileDownloadEvent`` +************************************************** + +.. versionadded:: 25 + +This event is triggered when a user tries to download a file +directly. + +``OCP\Files\Events\BeforeFileScannedEvent`` +******************************************* + +.. versionadded:: 18 + + +``OCP\Files\Events\BeforeFolderScannedEvent`` +********************************************* + +.. versionadded:: 18 + + +``OCP\Files\Events\BeforeZipCreatedEvent`` +****************************************** + +.. versionadded:: 25 + + +``OCP\Files\Events\FileCacheUpdated`` +************************************* + +.. versionadded:: 18 ``OCP\Files\Events\FileScannedEvent`` @@ -393,17 +338,12 @@ Event for when a new entry gets added to the cache .. versionadded:: 18 -``OCP\Files\Events\NodeAddedToFavorite`` -**************************************** +``OCP\Files\Events\InvalidateMountCacheEvent`` +********************************************** -.. versionadded:: 28 - - -``OCP\Files\Events\BeforeFileScannedEvent`` -******************************************* - -.. versionadded:: 18 +.. versionadded:: 24 +Used to notify the filesystem setup manager that the available mounts for a user have changed ``OCP\Files\Events\Node\BeforeNodeCopiedEvent`` *********************************************** @@ -411,48 +351,49 @@ Event for when a new entry gets added to the cache .. versionadded:: 20 -``OCP\Files\Events\Node\BeforeNodeTouchedEvent`` -************************************************ - -.. versionadded:: 20 - - -``OCP\Files\Events\Node\BeforeNodeRenamedEvent`` -************************************************ - -.. versionadded:: 20 - - -``OCP\Files\Events\Node\NodeDeletedEvent`` -****************************************** - -.. versionadded:: 20 - - ``OCP\Files\Events\Node\BeforeNodeCreatedEvent`` ************************************************ .. versionadded:: 20 +``OCP\Files\Events\Node\BeforeNodeDeletedEvent`` +************************************************ + +.. versionadded:: 20 + + ``OCP\Files\Events\Node\BeforeNodeReadEvent`` ********************************************* .. versionadded:: 20 -``OCP\Files\Events\Node\NodeRenamedEvent`` -****************************************** - -.. versionadded:: 20 - - -``OCP\Files\Events\Node\BeforeNodeDeletedEvent`` +``OCP\Files\Events\Node\BeforeNodeRenamedEvent`` ************************************************ .. versionadded:: 20 +``OCP\Files\Events\Node\BeforeNodeTouchedEvent`` +************************************************ + +.. versionadded:: 20 + + +``OCP\Files\Events\Node\BeforeNodeWrittenEvent`` +************************************************ + +.. versionadded:: 20 + + +``OCP\Files\Events\Node\FilesystemTornDownEvent`` +************************************************* + +.. versionadded:: 24 + +Event fired after the filesystem has been torn down + ``OCP\Files\Events\Node\NodeCopiedEvent`` ***************************************** @@ -465,21 +406,20 @@ Event for when a new entry gets added to the cache .. versionadded:: 20 -``OCP\Files\Events\Node\FilesystemTornDownEvent`` -************************************************* - -.. versionadded:: 24 - -Event fired after the filesystem has been torn down - -``OCP\Files\Events\Node\NodeTouchedEvent`` +``OCP\Files\Events\Node\NodeDeletedEvent`` ****************************************** .. versionadded:: 20 -``OCP\Files\Events\Node\BeforeNodeWrittenEvent`` -************************************************ +``OCP\Files\Events\Node\NodeRenamedEvent`` +****************************************** + +.. versionadded:: 20 + + +``OCP\Files\Events\Node\NodeTouchedEvent`` +****************************************** .. versionadded:: 20 @@ -490,16 +430,16 @@ Event fired after the filesystem has been torn down .. versionadded:: 20 -``OCP\Files\Events\FileCacheUpdated`` +``OCP\Files\Events\NodeAddedToCache`` ************************************* .. versionadded:: 18 -``OCP\Files\Events\BeforeZipCreatedEvent`` -****************************************** +``OCP\Files\Events\NodeAddedToFavorite`` +**************************************** -.. versionadded:: 25 +.. versionadded:: 28 ``OCP\Files\Events\NodeRemovedFromCache`` @@ -508,31 +448,16 @@ Event fired after the filesystem has been torn down .. versionadded:: 18 -``OCP\Files\Events\BeforeDirectFileDownloadEvent`` -************************************************** +``OCP\Files\Events\NodeRemovedFromFavorite`` +******************************************** -.. versionadded:: 25 - -This event is triggered when a user tries to download a file -directly. - -``OCP\Files\Events\BeforeFolderScannedEvent`` -********************************************* - -.. versionadded:: 18 +.. versionadded:: 28 -``OCP\Files\Events\InvalidateMountCacheEvent`` +``OCP\Files\Template\BeforeGetTemplatesEvent`` ********************************************** -.. versionadded:: 24 - -Used to notify the filesystem setup manager that the available mounts for a user have changed - -``OCP\Files\Events\NodeAddedToCache`` -************************************* - -.. versionadded:: 18 +.. versionadded:: 30 ``OCP\Files\Template\FileCreatedFromTemplateEvent`` @@ -547,24 +472,140 @@ Used to notify the filesystem setup manager that the available mounts for a user .. versionadded:: 30 -``OCP\Config\BeforePreferenceDeletedEvent`` -******************************************* +``OCP\FilesMetadata\Event\MetadataBackgroundEvent`` +*************************************************** -.. versionadded:: 25 +.. versionadded:: 28 + +MetadataBackgroundEvent is an event similar to MetadataLiveEvent but dispatched +on a background thread instead of live thread. Meaning there is no limit to +the time required for the generation of your metadata. + +``OCP\FilesMetadata\Event\MetadataLiveEvent`` +********************************************* + +.. versionadded:: 28 + +MetadataLiveEvent is an event initiated when a file is created or updated. +The app contains the Node related to the created/updated file, and a FilesMetadata that already +contains the currently known metadata. + +Setting new metadata, or modifying already existing metadata with different value, will trigger +the save of the metadata in the database. + +``OCP\FilesMetadata\Event\MetadataNamedEvent`` +********************************************** + +.. versionadded:: 28 + +MetadataNamedEvent is an event similar to MetadataBackgroundEvent completed with a target name, +used to limit the refresh of metadata only listeners capable of filtering themselves out. +Meaning that when using this event, your app must implement a filter on the event's registered +name returned by getName() + +This event is mostly triggered when a registered name is added to the files scan + i.e. ./occ files:scan --generate-metadata [name] + +``OCP\Group\Events\BeforeGroupChangedEvent`` +******************************************** + +.. versionadded:: 26 -``OCP\Config\BeforePreferenceSetEvent`` -*************************************** - -.. versionadded:: 25 - - -``OCP\DirectEditing\RegisterDirectEditorEvent`` -*********************************************** +``OCP\Group\Events\BeforeGroupCreatedEvent`` +******************************************** .. versionadded:: 18 -Event to allow to register the direct editor. + +``OCP\Group\Events\BeforeGroupDeletedEvent`` +******************************************** + +.. versionadded:: 18 + + +``OCP\Group\Events\BeforeUserAddedEvent`` +***************************************** + +.. versionadded:: 18 + + +``OCP\Group\Events\BeforeUserRemovedEvent`` +******************************************* + +.. versionadded:: 18 + + +``OCP\Group\Events\GroupChangedEvent`` +************************************** + +.. versionadded:: 26 + + +``OCP\Group\Events\GroupCreatedEvent`` +************************************** + +.. versionadded:: 18 + + +``OCP\Group\Events\GroupDeletedEvent`` +************************************** + +.. versionadded:: 18 + + +``OCP\Group\Events\SubAdminAddedEvent`` +*************************************** + +.. versionadded:: 21 + + +``OCP\Group\Events\SubAdminRemovedEvent`` +***************************************** + +.. versionadded:: 21 + + +``OCP\Group\Events\UserAddedEvent`` +*********************************** + +.. versionadded:: 18 + + +``OCP\Group\Events\UserRemovedEvent`` +************************************* + +.. versionadded:: 18 + + +``OCP\Log\Audit\CriticalActionPerformedEvent`` +********************************************** + +.. versionadded:: 22 + +Emitted when the admin_audit app should log an entry + +``OCP\Log\BeforeMessageLoggedEvent`` +************************************ + +.. versionadded:: 28 + +Even for when a log item is being logged + +``OCP\Mail\Events\BeforeMessageSent`` +************************************* + +.. versionadded:: 19 + +Emitted before a system mail is sent. It can be used to alter the message. + +``OCP\OCM\Events\ResourceTypeRegisterEvent`` +******************************************** + +.. versionadded:: 28 + +Use this event to register additional OCM resources before the API returns +them in the OCM provider list and capability ``OCP\Preview\BeforePreviewFetchedEvent`` ***************************************** @@ -577,19 +618,18 @@ Event to allow to register the direct editor. Emitted before a file preview is being fetched. It can be used to block preview rendering by throwing a ``OCP\Files\NotFoundException`` -``OCP\SpeechToText\Events\TranscriptionSuccessfulEvent`` -******************************************************** +``OCP\Profile\BeforeTemplateRenderedEvent`` +******************************************* -.. versionadded:: 27 +.. versionadded:: 25 -This Event is emitted when a transcription of a media file happened successfully +Emitted before the rendering step of the public profile page happens. -``OCP\SpeechToText\Events\TranscriptionFailedEvent`` -**************************************************** +``OCP\SabrePluginEvent`` +************************ -.. versionadded:: 27 +.. versionadded:: 8.2 -This Event is emitted if a transcription of a media file using a Speech-To-Text provider failed ``OCP\Security\CSP\AddContentSecurityPolicyEvent`` ************************************************** @@ -611,12 +651,16 @@ that it is not possible to use the `disallowXYZ` functions. .. versionadded:: 18 +Event to request a secure password to be generated ``OCP\Security\Events\ValidatePasswordPolicyEvent`` *************************************************** .. versionadded:: 18 +This event can be emitted to request a validation of a password. +If a password policy app is installed and the password +is invalid, an `\OCP\HintException` will be thrown. ``OCP\Security\FeaturePolicy\AddFeaturePolicyEvent`` **************************************************** @@ -625,158 +669,79 @@ that it is not possible to use the `disallowXYZ` functions. Event that allows to register a feature policy header to a request. -``OCP\User\GetQuotaEvent`` -************************** +``OCP\Settings\Events\DeclarativeSettingsGetValueEvent`` +******************************************************** -.. versionadded:: 20 - -Event to allow apps to - -``OCP\User\Events\UserChangedEvent`` -************************************ - -.. versionadded:: 18 +.. versionadded:: 29 -``OCP\User\Events\UserLiveStatusEvent`` -*************************************** +``OCP\Settings\Events\DeclarativeSettingsRegisterFormEvent`` +************************************************************ -.. versionadded:: 20 +.. versionadded:: 29 -``OCP\User\Events\BeforePasswordUpdatedEvent`` -********************************************** +``OCP\Settings\Events\DeclarativeSettingsSetValueEvent`` +******************************************************** -.. versionadded:: 18 - -Emitted before the user password is updated. - -``OCP\User\Events\UserDeletedEvent`` -************************************ - -.. versionadded:: 18 +.. versionadded:: 29 -``OCP\User\Events\BeforeUserDeletedEvent`` -****************************************** - -.. versionadded:: 18 - - -``OCP\User\Events\BeforeUserCreatedEvent`` -****************************************** - -.. versionadded:: 18 - -Emitted before a new user is created on the back-end. - -``OCP\User\Events\OutOfOfficeClearedEvent`` -******************************************* - -.. versionadded:: 28 - -Emitted when a user's out-of-office period is cleared - -``OCP\User\Events\BeforeUserLoggedInEvent`` -******************************************* - -.. versionadded:: 18 - - -``OCP\User\Events\UserFirstTimeLoggedInEvent`` -********************************************** - -.. versionadded:: 28 - - -``OCP\User\Events\UserCreatedEvent`` -************************************ - -.. versionadded:: 18 - -Emitted when a new user has been created on the back-end. - -``OCP\User\Events\UserLoggedInWithCookieEvent`` -*********************************************** - -.. versionadded:: 18 - -Emitted when a user has been successfully logged in via remember-me cookies. - -``OCP\User\Events\PasswordUpdatedEvent`` -**************************************** - -.. versionadded:: 18 - -Emitted when the user password has been updated. - -``OCP\User\Events\OutOfOfficeScheduledEvent`` -********************************************* - -.. versionadded:: 28 - -Emitted when a user's out-of-office period is scheduled - -``OCP\User\Events\PostLoginEvent`` -********************************** - -.. versionadded:: 18 - - -``OCP\User\Events\OutOfOfficeChangedEvent`` -******************************************* - -.. versionadded:: 28 - -Emitted when a user's out-of-office period has changed - -``OCP\User\Events\OutOfOfficeStartedEvent`` -******************************************* - -.. versionadded:: 28 - -Emitted when a user's out-of-office period started - -``OCP\User\Events\BeforeUserLoggedOutEvent`` +``OCP\Share\Events\BeforeShareCreatedEvent`` ******************************************** -.. versionadded:: 18 +.. versionadded:: 28 -Emitted before a user is logged out. -``OCP\User\Events\OutOfOfficeEndedEvent`` -***************************************** +``OCP\Share\Events\BeforeShareDeletedEvent`` +******************************************** .. versionadded:: 28 -Emitted when a user's out-of-office period ended -``OCP\User\Events\UserLoggedOutEvent`` +``OCP\Share\Events\ShareAcceptedEvent`` +*************************************** + +.. versionadded:: 28 + + +``OCP\Share\Events\ShareCreatedEvent`` ************************************** .. versionadded:: 18 -Emitted when a user has been logged out successfully. -``OCP\User\Events\UserLoggedInEvent`` -************************************* +``OCP\Share\Events\ShareDeletedEvent`` +************************************** -.. versionadded:: 18 +.. versionadded:: 21 -``OCP\User\Events\BeforeUserLoggedInWithCookieEvent`` -***************************************************** +``OCP\Share\Events\ShareDeletedFromSelfEvent`` +********************************************** -.. versionadded:: 18 +.. versionadded:: 28 -Emitted before a user is logged in via remember-me cookies. -``OCP\SystemTag\MapperEvent`` -***************************** +``OCP\Share\Events\VerifyMountPointEvent`` +****************************************** -.. versionadded:: 9 +.. versionadded:: 19 -Class MapperEvent + +``OCP\SpeechToText\Events\TranscriptionFailedEvent`` +**************************************************** + +.. versionadded:: 27 + +This Event is emitted if a transcription of a media file using a Speech-To-Text provider failed + +``OCP\SpeechToText\Events\TranscriptionSuccessfulEvent`` +******************************************************** + +.. versionadded:: 27 + +This Event is emitted when a transcription of a media file happened successfully ``OCP\SystemTag\ManagerEvent`` ****************************** @@ -785,6 +750,13 @@ Class MapperEvent Class ManagerEvent +``OCP\SystemTag\MapperEvent`` +***************************** + +.. versionadded:: 9 + +Class MapperEvent + ``OCP\SystemTag\SystemTagsEntityEvent`` *************************************** @@ -807,151 +779,6 @@ Class SystemTagsEntityEvent .. versionadded:: 30 -``OCP\EventDispatcher\GenericEvent`` -************************************ - -.. versionadded:: 18 - -Class GenericEvent -convenience reimplementation of \Symfony\Component\GenericEvent against -\OCP\EventDispatcher\Event - -``OCP\BeforeSabrePubliclyLoadedEvent`` -************************************** - -.. versionadded:: 26 - -Dispatched before Sabre is loaded when accessing public webdav endpoints -This can be used to inject a Sabre plugin for example - -``OCP\Console\ConsoleEvent`` -**************************** - -.. versionadded:: 9 - -Class ConsoleEvent - -``OCP\Log\BeforeMessageLoggedEvent`` -************************************ - -.. versionadded:: 28 - -Even for when a log item is being logged - -``OCP\Log\Audit\CriticalActionPerformedEvent`` -********************************************** - -.. versionadded:: 22 - -Emitted when the admin_audit app should log an entry - -``OCP\DB\Events\AddMissingIndicesEvent`` -**************************************** - -.. versionadded:: 28 - -Event to allow apps to register information about missing database indices -This event will be dispatched for checking on the admin settings and when running -occ db:add-missing-indices which will then create those indices - -``OCP\DB\Events\AddMissingColumnsEvent`` -**************************************** - -.. versionadded:: 28 - -Event to allow apps to register information about missing database columns -This event will be dispatched for checking on the admin settings and when running -occ db:add-missing-columns which will then create those columns - -``OCP\DB\Events\AddMissingPrimaryKeyEvent`` -******************************************* - -.. versionadded:: 28 - -Event to allow apps to register information about missing database primary keys -This event will be dispatched for checking on the admin settings and when running -occ db:add-missing-primary-keys which will then create those keys - -``OCP\Group\Events\GroupCreatedEvent`` -************************************** - -.. versionadded:: 18 - - -``OCP\Group\Events\UserRemovedEvent`` -************************************* - -.. versionadded:: 18 - - -``OCP\Group\Events\SubAdminRemovedEvent`` -***************************************** - -.. versionadded:: 21 - - -``OCP\Group\Events\BeforeGroupCreatedEvent`` -******************************************** - -.. versionadded:: 18 - - -``OCP\Group\Events\UserAddedEvent`` -*********************************** - -.. versionadded:: 18 - - -``OCP\Group\Events\GroupDeletedEvent`` -************************************** - -.. versionadded:: 18 - - -``OCP\Group\Events\GroupChangedEvent`` -************************************** - -.. versionadded:: 26 - - -``OCP\Group\Events\BeforeUserAddedEvent`` -***************************************** - -.. versionadded:: 18 - - -``OCP\Group\Events\BeforeUserRemovedEvent`` -******************************************* - -.. versionadded:: 18 - - -``OCP\Group\Events\BeforeGroupChangedEvent`` -******************************************** - -.. versionadded:: 26 - - -``OCP\Group\Events\SubAdminAddedEvent`` -*************************************** - -.. versionadded:: 21 - - -``OCP\Group\Events\BeforeGroupDeletedEvent`` -******************************************** - -.. versionadded:: 18 - - -``OCP\OCM\Events\ResourceTypeRegisterEvent`` -******************************************** - -.. versionadded:: 28 - -Use this event to register additional OCM resources before the API returns -them in the OCM provider list and capability - ``OCP\TextProcessing\Events\TaskFailedEvent`` ********************************************* @@ -963,3 +790,187 @@ them in the OCM provider list and capability .. versionadded:: 27.1 + +``OCP\TextToImage\Events\TaskFailedEvent`` +****************************************** + +.. versionadded:: 28 + + +``OCP\TextToImage\Events\TaskSuccessfulEvent`` +********************************************** + +.. versionadded:: 28 + + +``OCP\User\Events\BeforePasswordUpdatedEvent`` +********************************************** + +.. versionadded:: 18 + +Emitted before the user password is updated. + +``OCP\User\Events\BeforeUserCreatedEvent`` +****************************************** + +.. versionadded:: 18 + +Emitted before a new user is created on the back-end. + +``OCP\User\Events\BeforeUserDeletedEvent`` +****************************************** + +.. versionadded:: 18 + + +``OCP\User\Events\BeforeUserLoggedInEvent`` +******************************************* + +.. versionadded:: 18 + + +``OCP\User\Events\BeforeUserLoggedInWithCookieEvent`` +***************************************************** + +.. versionadded:: 18 + +Emitted before a user is logged in via remember-me cookies. + +``OCP\User\Events\BeforeUserLoggedOutEvent`` +******************************************** + +.. versionadded:: 18 + +Emitted before a user is logged out. + +``OCP\User\Events\OutOfOfficeChangedEvent`` +******************************************* + +.. versionadded:: 28 + +Emitted when a user's out-of-office period has changed + +``OCP\User\Events\OutOfOfficeClearedEvent`` +******************************************* + +.. versionadded:: 28 + +Emitted when a user's out-of-office period is cleared + +``OCP\User\Events\OutOfOfficeEndedEvent`` +***************************************** + +.. versionadded:: 28 + +Emitted when a user's out-of-office period ended + +``OCP\User\Events\OutOfOfficeScheduledEvent`` +********************************************* + +.. versionadded:: 28 + +Emitted when a user's out-of-office period is scheduled + +``OCP\User\Events\OutOfOfficeStartedEvent`` +******************************************* + +.. versionadded:: 28 + +Emitted when a user's out-of-office period started + +``OCP\User\Events\PasswordUpdatedEvent`` +**************************************** + +.. versionadded:: 18 + +Emitted when the user password has been updated. + +``OCP\User\Events\PostLoginEvent`` +********************************** + +.. versionadded:: 18 + + +``OCP\User\Events\UserChangedEvent`` +************************************ + +.. versionadded:: 18 + + +``OCP\User\Events\UserCreatedEvent`` +************************************ + +.. versionadded:: 18 + +Emitted when a new user has been created on the back-end. + +``OCP\User\Events\UserDeletedEvent`` +************************************ + +.. versionadded:: 18 + + +``OCP\User\Events\UserFirstTimeLoggedInEvent`` +********************************************** + +.. versionadded:: 28 + + +``OCP\User\Events\UserLiveStatusEvent`` +*************************************** + +.. versionadded:: 20 + + +``OCP\User\Events\UserLoggedInEvent`` +************************************* + +.. versionadded:: 18 + + +``OCP\User\Events\UserLoggedInWithCookieEvent`` +*********************************************** + +.. versionadded:: 18 + +Emitted when a user has been successfully logged in via remember-me cookies. + +``OCP\User\Events\UserLoggedOutEvent`` +************************************** + +.. versionadded:: 18 + +Emitted when a user has been logged out successfully. + +``OCP\User\GetQuotaEvent`` +************************** + +.. versionadded:: 20 + +Event to allow apps to + +``OCP\WorkflowEngine\Events\LoadSettingsScriptsEvent`` +****************************************************** + +.. versionadded:: 20 + +Emitted when the workflow engine settings page is loaded. + +``OCP\WorkflowEngine\Events\RegisterChecksEvent`` +************************************************* + +.. versionadded:: 18 + + +``OCP\WorkflowEngine\Events\RegisterEntitiesEvent`` +*************************************************** + +.. versionadded:: 18 + + +``OCP\WorkflowEngine\Events\RegisterOperationsEvent`` +***************************************************** + +.. versionadded:: 18 + +