OCP\Accounts\UserUpdatedEvent

This event is triggered when the account data of a user was updated.

OCP\App\Events\AppDisableEvent

This event is triggered when an app is disabled.

OCP\App\Events\AppEnableEvent

This event is triggered when an app is enabled.

OCP\App\Events\AppUpdateEvent

This event is triggered when an app is updated.

OCP\App\ManagerEvent

Class ManagerEvent

OCP\AppFramework\Http\Events\BeforeLoginTemplateRenderedEvent

Emitted before the rendering step of the login TemplateResponse.

OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent

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

Emitted when the authentication fails

OCP\Authentication\Events\LoginFailedEvent

Emitted when the authentication fails, but only if the login name can be associated with an existing user.

OCP\Authentication\Events\TokenInvalidatedEvent

Emitted when an authentication token is invalidated.

OCP\Authentication\TwoFactorAuth\RegistryEvent

OCP\Authentication\TwoFactorAuth\TwoFactorProviderChallengeFailed

OCP\Authentication\TwoFactorAuth\TwoFactorProviderChallengePassed

OCP\Authentication\TwoFactorAuth\TwoFactorProviderDisabled

OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserDisabled

OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserEnabled

OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserRegistered

OCP\Authentication\TwoFactorAuth\TwoFactorProviderForUserUnregistered

OCP\Authentication\TwoFactorAuth\TwoFactorProviderUserDeleted

OCP\BeforeSabrePubliclyLoadedEvent

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

OCP\Calendar\Events\CalendarObjectDeletedEvent

OCP\Calendar\Events\CalendarObjectMovedEvent

OCP\Calendar\Events\CalendarObjectMovedToTrashEvent

OCP\Calendar\Events\CalendarObjectRestoredEvent

OCP\Calendar\Events\CalendarObjectUpdatedEvent

OCP\Collaboration\AutoComplete\AutoCompleteEvent

OCP\Collaboration\AutoComplete\AutoCompleteFilterEvent

OCP\Collaboration\Reference\RenderReferenceEvent

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 :ref:`Reference providers` deep dive.

OCP\Collaboration\Resources\LoadAdditionalScriptsEvent

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

Class CommentsEntityEvent

OCP\Comments\CommentsEvent

Class CommentsEvent

OCP\Config\BeforePreferenceDeletedEvent

OCP\Config\BeforePreferenceSetEvent

OCP\Console\ConsoleEvent

Class ConsoleEvent

OCP\Contacts\Events\ContactInteractedWithEvent

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

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

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

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

Event to allow to register the direct editor.

OCP\EventDispatcher\GenericEvent

Class GenericEvent convenience re-implementation of SymfonyComponentGenericEvent against OCPEventDispatcherEvent

OCP\Federation\Events\TrustedServerRemovedEvent

OCP\Files\Cache\AbstractCacheEvent

OCP\Files\Cache\CacheEntryInsertedEvent

Event for when an existing entry in the cache gets inserted

OCP\Files\Cache\CacheEntryRemovedEvent

Event for when an existing entry in the cache gets removed

OCP\Files\Cache\CacheEntryUpdatedEvent

Event for when an existing entry in the cache gets updated

OCP\Files\Cache\CacheInsertEvent

Event for when a new entry gets added to the cache

OCP\Files\Cache\CacheUpdateEvent

Event for when an existing entry in the cache gets updated

OCP\Files\Config\Event\UserMountAddedEvent

Event emitted when a user mount was added.

OCP\Files\Config\Event\UserMountRemovedEvent

Event emitted when a user mount was removed.

OCP\Files\Config\Event\UserMountUpdatedEvent

Event emitted when a user mount was moved.

OCP\Files\Events\BeforeDirectFileDownloadEvent

This event is triggered when a user tries to download a file directly.

OCP\Files\Events\BeforeFileScannedEvent

OCP\Files\Events\BeforeFileSystemSetupEvent

Event triggered before the file system is setup

OCP\Files\Events\BeforeFolderScannedEvent

OCP\Files\Events\BeforeZipCreatedEvent

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

OCP\Files\Events\FileScannedEvent

OCP\Files\Events\FolderScannedEvent

OCP\Files\Events\InvalidateMountCacheEvent

Used to notify the filesystem setup manager that the available mounts for a user have changed

OCP\Files\Events\Node\BeforeNodeCopiedEvent

OCP\Files\Events\Node\BeforeNodeCreatedEvent

OCP\Files\Events\Node\BeforeNodeDeletedEvent

OCP\Files\Events\Node\BeforeNodeReadEvent

OCP\Files\Events\Node\BeforeNodeRenamedEvent

OCP\Files\Events\Node\BeforeNodeTouchedEvent

OCP\Files\Events\Node\BeforeNodeWrittenEvent

OCP\Files\Events\Node\FilesystemTornDownEvent

Event fired after the filesystem has been torn down

OCP\Files\Events\Node\NodeCopiedEvent

OCP\Files\Events\Node\NodeCreatedEvent

OCP\Files\Events\Node\NodeDeletedEvent

OCP\Files\Events\Node\NodeRenamedEvent

OCP\Files\Events\Node\NodeTouchedEvent

OCP\Files\Events\Node\NodeWrittenEvent

OCP\Files\Events\NodeAddedToCache

OCP\Files\Events\NodeAddedToFavorite

OCP\Files\Events\NodeRemovedFromCache

OCP\Files\Events\NodeRemovedFromFavorite

OCP\Files\ObjectStore\Events\BucketCreatedEvent

OCP\Files\Template\BeforeGetTemplatesEvent

OCP\Files\Template\FileCreatedFromTemplateEvent

OCP\Files\Template\RegisterTemplateCreatorEvent

OCP\FilesMetadata\Event\MetadataBackgroundEvent

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

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

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

OCP\Group\Events\BeforeGroupCreatedEvent

OCP\Group\Events\BeforeGroupDeletedEvent

OCP\Group\Events\BeforeUserAddedEvent

OCP\Group\Events\BeforeUserRemovedEvent

OCP\Group\Events\GroupChangedEvent

OCP\Group\Events\GroupCreatedEvent

OCP\Group\Events\GroupDeletedEvent

OCP\Group\Events\SubAdminAddedEvent

OCP\Group\Events\SubAdminRemovedEvent

OCP\Group\Events\UserAddedEvent

OCP\Group\Events\UserRemovedEvent

OCP\Log\Audit\CriticalActionPerformedEvent

Emitted when the admin_audit app should log an entry

OCP\Log\BeforeMessageLoggedEvent

Even for when a log item is being logged

OCP\Mail\Events\BeforeMessageSent

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

OCP\Navigation\Events\LoadAdditionalEntriesEvent

OCP\OCM\Events\ResourceTypeRegisterEvent

Use this event to register additional OCM resources before the API returns them in the OCM provider list and capability

OCP\Preview\BeforePreviewFetchedEvent

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

Emitted before the rendering step of the public profile page happens.

OCP\SabrePluginEvent

OCP\Security\CSP\AddContentSecurityPolicyEvent

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

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

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

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

OCP\Settings\Events\DeclarativeSettingsGetValueEvent

OCP\Settings\Events\DeclarativeSettingsRegisterFormEvent

OCP\Settings\Events\DeclarativeSettingsSetValueEvent

OCP\Share\Events\BeforeShareCreatedEvent

OCP\Share\Events\BeforeShareDeletedEvent

OCP\Share\Events\ShareAcceptedEvent

OCP\Share\Events\ShareCreatedEvent

OCP\Share\Events\ShareDeletedEvent

OCP\Share\Events\ShareDeletedFromSelfEvent

OCP\Share\Events\VerifyMountPointEvent

OCP\Share\ShareReview\Events\ShareReviewAccessCheckEvent

Authorization gate for deleting an app-managed share through a share-review app. Dispatched by the app that owns the share (its OCP\Share\ShareReview\IShareReviewSource implementation) at the beginning of deleteShare(), before anything is deleted. The share-review app listens to this event and answers with grantAccess() or denyAccess() depending on whether the current user is an authorized share-review operator; apps that merely expose shares must not listen to it. The event is default-deny: if no listener responds, the share must not be deleted. Once denied, further grants are ignored and event propagation is stopped.

OCP\Share\ShareReview\RegisterShareReviewSourceEvent

Event dispatched by a share-review app to collect share sources from other apps. Listeners register the class name of their OCP\Share\ShareReview\IShareReviewSource implementation, whose getShares() method returns a list of OCP\Share\ShareReview\ShareReviewEntry objects.

OCP\SpeechToText\Events\TranscriptionFailedEvent

This Event is emitted if a transcription of a media file using a Speech-To-Text provider failed

OCP\SpeechToText\Events\TranscriptionSuccessfulEvent

This Event is emitted when a transcription of a media file happened successfully

OCP\SystemTag\ManagerEvent

Class ManagerEvent

OCP\SystemTag\MapperEvent

Class MapperEvent

OCP\SystemTag\SystemTagsEntityEvent

Class SystemTagsEntityEvent

OCP\TaskProcessing\Events\GetTaskProcessingProvidersEvent

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

OCP\TaskProcessing\Events\TaskSuccessfulEvent

OCP\TextProcessing\Events\TaskFailedEvent

OCP\TextProcessing\Events\TaskSuccessfulEvent

OCP\TextToImage\Events\TaskFailedEvent

OCP\TextToImage\Events\TaskSuccessfulEvent

OCP\User\Events\BeforePasswordUpdatedEvent

Emitted before the user password is updated.

OCP\User\Events\BeforeUserCreatedEvent

Emitted before a new user is created on the back-end.

OCP\User\Events\BeforeUserDeletedEvent

OCP\User\Events\BeforeUserIdUnassignedEvent

Emitted before removing the mapping between an external user and an internal userid

OCP\User\Events\BeforeUserLoggedInEvent

OCP\User\Events\BeforeUserLoggedInWithCookieEvent

Emitted before a user is logged in via remember-me cookies.

OCP\User\Events\BeforeUserLoggedOutEvent

Emitted before a user is logged out.

OCP\User\Events\OutOfOfficeChangedEvent

Emitted when a user's out-of-office period has changed

OCP\User\Events\OutOfOfficeClearedEvent

Emitted when a user's out-of-office period is cleared

OCP\User\Events\OutOfOfficeEndedEvent

Emitted when a user's out-of-office period ended

OCP\User\Events\OutOfOfficeScheduledEvent

Emitted when a user's out-of-office period is scheduled

OCP\User\Events\OutOfOfficeStartedEvent

Emitted when a user's out-of-office period started

OCP\User\Events\PasswordUpdatedEvent

Emitted when the user password has been updated.

OCP\User\Events\PostLoginEvent

OCP\User\Events\UserChangedEvent

OCP\User\Events\UserCreatedEvent

Emitted when a new user has been created on the back-end.

OCP\User\Events\UserDeletedEvent

OCP\User\Events\UserFirstTimeLoggedInEvent

OCP\User\Events\UserIdAssignedEvent

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

Emitted after removing the mapping between an external user and an internal userid

OCP\User\Events\UserLiveStatusEvent

OCP\User\Events\UserLoggedInEvent

OCP\User\Events\UserLoggedInWithCookieEvent

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

OCP\User\Events\UserLoggedOutEvent

Emitted when a user has been logged out successfully.

OCP\User\GetQuotaEvent

Event to allow apps to

OCP\WorkflowEngine\Events\LoadSettingsScriptsEvent

Emitted when the workflow engine settings page is loaded.

OCP\WorkflowEngine\Events\RegisterChecksEvent

OCP\WorkflowEngine\Events\RegisterEntitiesEvent

OCP\WorkflowEngine\Events\RegisterOperationsEvent