OCP\Accounts\UserUpdatedEvent
Added in version 28.
This event is triggered when the account data of a user was updated.
OCP\App\Events\AppDisableEvent
Added in version 27.
This event is triggered when an app is disabled.
OCP\App\Events\AppEnableEvent
Added in version 27.
This event is triggered when an app is enabled.
OCP\App\Events\AppUpdateEvent
Added in version 27.
This event is triggered when an app is updated.
OCP\App\ManagerEvent
Added in version 9.
Class ManagerEvent
OCP\AppFramework\Http\Events\BeforeLoginTemplateRenderedEvent
Added in version 28.
Emitted before the rendering step of the login TemplateResponse.
OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent
Added in version 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
Added in version 26.
Emitted when the authentication fails
OCP\Authentication\Events\LoginFailedEvent
Added in version 19.
Emitted when the authentication fails, but only if the login name can be associated with an existing user.
OCP\Authentication\TwoFactorAuth\RegistryEvent
Added in version 15.
OCP\Authentication\TwoFactorAuth\TwoFactorProviderChallengeFailed
Added in version 28.
OCP\Authentication\TwoFactorAuth\TwoFactorProviderChallengePassed
Added in version 28.
OCP\Authentication\TwoFactorAuth\TwoFactorProviderDisabled
Added in version 20.
OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserDisabled
Added in version 22.
OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserEnabled
Added in version 22.
OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserRegistered
Added in version 28.
OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserUnregistered
Added in version 28.
OCP\Authentication\TwoFactorAuth\TwoFactorProviderUserDeleted
Added in version 28.
OCP\BeforeSabrePubliclyLoadedEvent
Added in version 26.
Dispatched before Sabre is loaded when accessing public webdav endpoints This can be used to inject a Sabre plugin for example
OCP\Calendar\Events\CalendarObjectCreatedEvent
Added in version 32.
OCP\Calendar\Events\CalendarObjectDeletedEvent
Added in version 32.
OCP\Calendar\Events\CalendarObjectMovedEvent
Added in version 32.
OCP\Calendar\Events\CalendarObjectMovedToTrashEvent
Added in version 32.
OCP\Calendar\Events\CalendarObjectRestoredEvent
Added in version 32.
OCP\Calendar\Events\CalendarObjectUpdatedEvent
Added in version 32.
OCP\Collaboration\AutoComplete\AutoCompleteEvent
Added in version 16.
OCP\Collaboration\AutoComplete\AutoCompleteFilterEvent
Added in version 28.
OCP\Collaboration\Reference\RenderReferenceEvent
Added in version 25.
Event emitted when apps might render references like link previews or smart picker widgets. This can be used to inject scripts for extending that. Further details can be found in the Reference providers deep dive.
OCP\Collaboration\Resources\LoadAdditionalScriptsEvent
Added in version 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
Added in version 9.1.
Changed in version 28.0.0: Dispatched as a typed event
Class CommentsEntityEvent
OCP\Comments\CommentsEvent
Added in version 9.
Class CommentsEvent
OCP\Config\BeforePreferenceDeletedEvent
Added in version 25.
OCP\Config\BeforePreferenceSetEvent
Added in version 25.
OCP\Console\ConsoleEvent
Added in version 9.
Class ConsoleEvent
OCP\Contacts\Events\ContactInteractedWithEvent
Added in version 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
Added in version 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\AddMissingIndicesEvent
Added in version 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\AddMissingPrimaryKeyEvent
Added in version 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
Added in version 18.
Event to allow to register the direct editor.
OCP\EventDispatcher\GenericEvent
Added in version 18.
Class GenericEvent convenience re-implementation of SymfonyComponentGenericEvent against OCPEventDispatcherEvent
OCP\Federation\Events\TrustedServerRemovedEvent
Added in version 25.
OCP\Files\Cache\AbstractCacheEvent
Added in version 22.
OCP\Files\Cache\CacheEntryInsertedEvent
Added in version 21.
Event for when an existing entry in the cache gets inserted
OCP\Files\Cache\CacheEntryRemovedEvent
Added in version 21.
Event for when an existing entry in the cache gets removed
OCP\Files\Cache\CacheEntryUpdatedEvent
Added in version 21.
Event for when an existing entry in the cache gets updated
OCP\Files\Cache\CacheInsertEvent
Added in version 16.
Event for when a new entry gets added to the cache
OCP\Files\Cache\CacheUpdateEvent
Added in version 16.
Event for when an existing entry in the cache gets updated
OCP\Files\Config\Event\UserMountAddedEvent
Added in version 31.
Event emitted when a user mount was added.
OCP\Files\Config\Event\UserMountRemovedEvent
Added in version 31.
Event emitted when a user mount was removed.
OCP\Files\Config\Event\UserMountUpdatedEvent
Added in version 31.
Event emitted when a user mount was moved.
OCP\Files\Events\BeforeDirectFileDownloadEvent
Added in version 25.
This event is triggered when a user tries to download a file directly.
OCP\Files\Events\BeforeFileScannedEvent
Added in version 18.
OCP\Files\Events\BeforeFileSystemSetupEvent
Added in version 31.
Event triggered before the file system is setup
OCP\Files\Events\BeforeFolderScannedEvent
Added in version 18.
OCP\Files\Events\BeforeZipCreatedEvent
Added in version 25.
This event is triggered before a archive is created when a user requested downloading a folder or multiple files. By setting successful to false the tar creation can be aborted and the download denied.
OCP\Files\Events\FileCacheUpdated
Added in version 18.
OCP\Files\Events\FileScannedEvent
Added in version 18.
OCP\Files\Events\FolderScannedEvent
Added in version 18.
OCP\Files\Events\InvalidateMountCacheEvent
Added in version 24.
Used to notify the filesystem setup manager that the available mounts for a user have changed
OCP\Files\Events\Node\BeforeNodeCopiedEvent
Added in version 20.
OCP\Files\Events\Node\BeforeNodeCreatedEvent
Added in version 20.
OCP\Files\Events\Node\BeforeNodeDeletedEvent
Added in version 20.
OCP\Files\Events\Node\BeforeNodeReadEvent
Added in version 20.
OCP\Files\Events\Node\BeforeNodeRenamedEvent
Added in version 20.
OCP\Files\Events\Node\BeforeNodeTouchedEvent
Added in version 20.
OCP\Files\Events\Node\BeforeNodeWrittenEvent
Added in version 20.
OCP\Files\Events\Node\FilesystemTornDownEvent
Added in version 24.
Event fired after the filesystem has been torn down
OCP\Files\Events\Node\NodeCopiedEvent
Added in version 20.
OCP\Files\Events\Node\NodeCreatedEvent
Added in version 20.
OCP\Files\Events\Node\NodeDeletedEvent
Added in version 20.
OCP\Files\Events\Node\NodeRenamedEvent
Added in version 20.
OCP\Files\Events\Node\NodeTouchedEvent
Added in version 20.
OCP\Files\Events\Node\NodeWrittenEvent
Added in version 20.
OCP\Files\Events\NodeAddedToCache
Added in version 18.
OCP\Files\Events\NodeAddedToFavorite
Added in version 28.
OCP\Files\Events\NodeRemovedFromCache
Added in version 18.
OCP\Files\Events\NodeRemovedFromFavorite
Added in version 28.
OCP\Files\Template\BeforeGetTemplatesEvent
Added in version 30.
OCP\Files\Template\FileCreatedFromTemplateEvent
Added in version 21.
OCP\Files\Template\RegisterTemplateCreatorEvent
Added in version 30.
OCP\FilesMetadata\Event\MetadataBackgroundEvent
Added in version 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
Added in version 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
Added in version 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
Added in version 26.
OCP\Group\Events\BeforeGroupCreatedEvent
Added in version 18.
OCP\Group\Events\BeforeGroupDeletedEvent
Added in version 18.
OCP\Group\Events\BeforeUserAddedEvent
Added in version 18.
OCP\Group\Events\BeforeUserRemovedEvent
Added in version 18.
OCP\Group\Events\GroupChangedEvent
Added in version 26.
OCP\Group\Events\GroupCreatedEvent
Added in version 18.
OCP\Group\Events\GroupDeletedEvent
Added in version 18.
OCP\Group\Events\SubAdminAddedEvent
Added in version 21.
OCP\Group\Events\SubAdminRemovedEvent
Added in version 21.
OCP\Group\Events\UserAddedEvent
Added in version 18.
OCP\Group\Events\UserRemovedEvent
Added in version 18.
OCP\Log\Audit\CriticalActionPerformedEvent
Added in version 22.
Emitted when the admin_audit app should log an entry
OCP\Log\BeforeMessageLoggedEvent
Added in version 28.
Even for when a log item is being logged
OCP\Mail\Events\BeforeMessageSent
Added in version 19.
Emitted before a system mail is sent. It can be used to alter the message.
OCP\OCM\Events\ResourceTypeRegisterEvent
Added in version 28.
Use this event to register additional OCM resources before the API returns them in the OCM provider list and capability
OCP\Preview\BeforePreviewFetchedEvent
Added in version 25.0.1.
Changed in version 28.0.0: the constructor arguments $width, $height, $crop and $mode are no longer nullable.
Changed in version 31.0.0: the constructor arguments $mimeType was added
Emitted before a file preview is being fetched.
It can be used to block preview rendering by throwing a OCP\Files\NotFoundException
OCP\Profile\BeforeTemplateRenderedEvent
Added in version 25.
Emitted before the rendering step of the public profile page happens.
OCP\SabrePluginEvent
Added in version 8.2.
OCP\Security\CSP\AddContentSecurityPolicyEvent
Added in version 17.
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
Added in version 18.
Event to request a secure password to be generated.
Since Nextcloud 31 this event also provides a getContext method
allowing to apply different rules for different password context like account passwords or share passwords.
OCP\Security\Events\ValidatePasswordPolicyEvent
Added in version 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 OCPHintException will be thrown.
Since Nextcloud 31 this event also provides a getContext method
allowing to apply different rules for different password context like account passwords or share passwords.
OCP\Security\FeaturePolicy\AddFeaturePolicyEvent
Added in version 17.
Event that allows to register a feature policy header to a request.
OCP\Settings\Events\DeclarativeSettingsGetValueEvent
Added in version 29.
OCP\Settings\Events\DeclarativeSettingsRegisterFormEvent
Added in version 29.
OCP\Settings\Events\DeclarativeSettingsSetValueEvent
Added in version 29.
OCP\SpeechToText\Events\TranscriptionFailedEvent
Added in version 27.
This Event is emitted if a transcription of a media file using a Speech-To-Text provider failed
OCP\SpeechToText\Events\TranscriptionSuccessfulEvent
Added in version 27.
This Event is emitted when a transcription of a media file happened successfully
OCP\SystemTag\ManagerEvent
Added in version 9.
Class ManagerEvent
OCP\SystemTag\MapperEvent
Added in version 9.
Class MapperEvent
OCP\TaskProcessing\Events\GetTaskProcessingProvidersEvent
Added in version 32.
Event dispatched by the server to collect Task Processing Providers and custom Task Types from listeners (like AppAPI). Listeners should add their providers and task types using the addProvider() and addTaskType() methods.
OCP\TaskProcessing\Events\TaskFailedEvent
Added in version 30.
OCP\TaskProcessing\Events\TaskSuccessfulEvent
Added in version 30.
OCP\TextProcessing\Events\TaskFailedEvent
Added in version 27.1.
OCP\TextProcessing\Events\TaskSuccessfulEvent
Added in version 27.1.
OCP\TextToImage\Events\TaskFailedEvent
Added in version 28.
OCP\TextToImage\Events\TaskSuccessfulEvent
Added in version 28.
OCP\User\Events\BeforePasswordUpdatedEvent
Added in version 18.
Emitted before the user password is updated.
OCP\User\Events\BeforeUserCreatedEvent
Added in version 18.
Emitted before a new user is created on the back-end.
OCP\User\Events\BeforeUserDeletedEvent
Added in version 18.
OCP\User\Events\BeforeUserIdUnassignedEvent
Added in version 31.
Emitted before removing the mapping between an external user and an internal userid
OCP\User\Events\BeforeUserLoggedInEvent
Added in version 18.
OCP\User\Events\BeforeUserLoggedOutEvent
Added in version 18.
Emitted before a user is logged out.
OCP\User\Events\OutOfOfficeChangedEvent
Added in version 28.
Emitted when a user’s out-of-office period has changed
OCP\User\Events\OutOfOfficeClearedEvent
Added in version 28.
Emitted when a user’s out-of-office period is cleared
OCP\User\Events\OutOfOfficeEndedEvent
Added in version 28.
Emitted when a user’s out-of-office period ended
OCP\User\Events\OutOfOfficeScheduledEvent
Added in version 28.
Emitted when a user’s out-of-office period is scheduled
OCP\User\Events\OutOfOfficeStartedEvent
Added in version 28.
Emitted when a user’s out-of-office period started
OCP\User\Events\PasswordUpdatedEvent
Added in version 18.
Emitted when the user password has been updated.
OCP\User\Events\PostLoginEvent
Added in version 18.
OCP\User\Events\UserChangedEvent
Added in version 18.
OCP\User\Events\UserCreatedEvent
Added in version 18.
Emitted when a new user has been created on the back-end.
OCP\User\Events\UserDeletedEvent
Added in version 18.
OCP\User\Events\UserFirstTimeLoggedInEvent
Added in version 28.
OCP\User\Events\UserIdAssignedEvent
Added in version 31.
Emitted by backends (like user_ldap) when a user created externally is mapped for the first time and assigned a userid
OCP\User\Events\UserIdUnassignedEvent
Added in version 31.
Emitted after removing the mapping between an external user and an internal userid
OCP\User\Events\UserLiveStatusEvent
Added in version 20.
OCP\User\Events\UserLoggedInEvent
Added in version 18.
OCP\User\Events\UserLoggedOutEvent
Added in version 18.
Emitted when a user has been logged out successfully.
OCP\User\GetQuotaEvent
Added in version 20.
Event to allow apps to
OCP\WorkflowEngine\Events\LoadSettingsScriptsEvent
Added in version 20.
Emitted when the workflow engine settings page is loaded.
OCP\WorkflowEngine\Events\RegisterChecksEvent
Added in version 18.
OCP\WorkflowEngine\Events\RegisterEntitiesEvent
Added in version 18.
OCP\WorkflowEngine\Events\RegisterOperationsEvent
Added in version 18.