Skip to content
Open
Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions lib/public/Config/BeforePreferenceDeletedEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
use OCP\AppFramework\Attribute\Listenable;
use OCP\EventDispatcher\Event;

/**
* Dispatched before a user preference is deleted via the preferences API; the deletion is rejected unless a listener marks it valid.
*
* @since 25.0.0
*/
#[Listenable(since: '25.0.0')]
class BeforePreferenceDeletedEvent extends Event {
protected string $userId;
Expand Down
5 changes: 5 additions & 0 deletions lib/public/Config/BeforePreferenceSetEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
use OCP\AppFramework\Attribute\Listenable;
use OCP\EventDispatcher\Event;

/**
* Dispatched before a user preference is set via the preferences API; the change is rejected unless a listener marks it valid.
*
* @since 25.0.0
*/
#[Listenable(since: '25.0.0')]
class BeforePreferenceSetEvent extends Event {
protected string $userId;
Expand Down
2 changes: 1 addition & 1 deletion lib/public/Interaction/RestrictInteractionEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* This event can be emitted to check if a user is allowed to perform an action, such that the receivers would become aware of the resources.
* If the resources have a distinction between an owner and a initiator, the event must be emitted for each separately.
* Emitters may omit one or multiple properties, if they are not known.
* Emitters must call {@see isInteractionRestricted} instead of dispatching the event manually, to ensure exception handling and audit logging is done correctly.
* Emitters must call {@see RestrictInteractionEvent::isInteractionRestricted()} instead of dispatching the event manually, to ensure exception handling and audit logging is done correctly.
* Listeners may ignore any of the properties and only check the ones that are relevant to them.
* Listeners must throw an {@see InteractionRestrictedException}, if they want to restrict the interaction.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
/**
* Event to request a secure password to be generated
* @since 18.0.0
* @since 31.0.0 Provides ``getContext`` to apply different rules per password context, e.g. account or share passwords.
*/
class GenerateSecurePasswordEvent extends Event {
private ?string $password;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
* If a password policy app is installed and the password
* is invalid, an `\OCP\HintException` will be thrown.
* @since 18.0.0
* @since 31.0.0 Provides ``getContext`` to apply different rules per password context, e.g. account or share passwords.
*/
class ValidatePasswordPolicyEvent extends Event {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@
use OCP\EventDispatcher\Event;

/**
* Event dispatched by a share-review app to collect share sources from other
* apps. Listeners register the class name of their {@see IShareReviewSource}
* Event dispatched by a share-review app to collect share sources from other apps.
*
* Listeners register the class name of their {@see IShareReviewSource}
* implementation; the share-review app resolves it from the dependency
* injection container.
*
Expand Down
Loading