Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update docs for ocp events #46708

Merged
merged 1 commit into from
Jul 24, 2024
Merged

docs: update docs for ocp events #46708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions lib/public/Accounts/UserUpdatedEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
use OCP\IUser;

/**
* This event is triggered when the account data of a user was updated.
*
* @since 28.0.0
*/
class UserUpdatedEvent extends Event {
Expand Down
2 changes: 2 additions & 0 deletions lib/public/App/Events/AppDisableEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
use OCP\EventDispatcher\Event;

/**
* This event is triggered when an app is disabled.
*
* @since 27.0.0
*/
class AppDisableEvent extends Event {
Expand Down
2 changes: 2 additions & 0 deletions lib/public/App/Events/AppEnableEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
use OCP\EventDispatcher\Event;

/**
* This event is triggered when an app is enabled.
*
* @since 27.0.0
*/
class AppEnableEvent extends Event {
Expand Down
2 changes: 2 additions & 0 deletions lib/public/App/Events/AppUpdateEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
use OCP\EventDispatcher\Event;

/**
* This event is triggered when an app is updated.
*
* @since 27.0.0
*/
class AppUpdateEvent extends Event {
Expand Down
6 changes: 4 additions & 2 deletions lib/public/Collaboration/Reference/RenderReferenceEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@
use OCP\EventDispatcher\Event;

/**
* Event that apps can emit on their page rendering to trigger loading of aditional
* scripts for reference widget rendering
* 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.
*
* @since 25.0.0
*/
Expand Down
5 changes: 5 additions & 0 deletions lib/public/Preview/BeforePreviewFetchedEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@
use OCP\IPreview;

/**
* Emitted before a file preview is being fetched.
*
* It can be used to block preview rendering by throwing a ``OCP\Files\NotFoundException``
*
* @since 25.0.1
* @since 28.0.0 the constructor arguments ``$width``, ``$height``, ``$crop`` and ``$mode`` are no longer nullable.
*/
class BeforePreviewFetchedEvent extends \OCP\EventDispatcher\Event {
/**
Expand Down
Loading