diff --git a/lib/public/Config/BeforePreferenceDeletedEvent.php b/lib/public/Config/BeforePreferenceDeletedEvent.php index df89a2900bd7f..b0ded7c821aac 100644 --- a/lib/public/Config/BeforePreferenceDeletedEvent.php +++ b/lib/public/Config/BeforePreferenceDeletedEvent.php @@ -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; diff --git a/lib/public/Config/BeforePreferenceSetEvent.php b/lib/public/Config/BeforePreferenceSetEvent.php index 6534e4ae371de..e082b10c127a3 100644 --- a/lib/public/Config/BeforePreferenceSetEvent.php +++ b/lib/public/Config/BeforePreferenceSetEvent.php @@ -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; diff --git a/lib/public/Interaction/RestrictInteractionEvent.php b/lib/public/Interaction/RestrictInteractionEvent.php index db97d33167cb9..ff07adf3717b1 100644 --- a/lib/public/Interaction/RestrictInteractionEvent.php +++ b/lib/public/Interaction/RestrictInteractionEvent.php @@ -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. * diff --git a/lib/public/Security/Events/GenerateSecurePasswordEvent.php b/lib/public/Security/Events/GenerateSecurePasswordEvent.php index f1d3e9348969c..d04bf73b22eba 100644 --- a/lib/public/Security/Events/GenerateSecurePasswordEvent.php +++ b/lib/public/Security/Events/GenerateSecurePasswordEvent.php @@ -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; diff --git a/lib/public/Security/Events/ValidatePasswordPolicyEvent.php b/lib/public/Security/Events/ValidatePasswordPolicyEvent.php index 1062a8373bb34..a93088815e5f6 100644 --- a/lib/public/Security/Events/ValidatePasswordPolicyEvent.php +++ b/lib/public/Security/Events/ValidatePasswordPolicyEvent.php @@ -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 { diff --git a/lib/public/Share/ShareReview/RegisterShareReviewSourceEvent.php b/lib/public/Share/ShareReview/RegisterShareReviewSourceEvent.php index 929277de64bc1..6b99ef8c7ff28 100644 --- a/lib/public/Share/ShareReview/RegisterShareReviewSourceEvent.php +++ b/lib/public/Share/ShareReview/RegisterShareReviewSourceEvent.php @@ -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. *