aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Preview
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Preview')
-rw-r--r--lib/public/Preview/BeforePreviewFetchedEvent.php22
-rw-r--r--lib/public/Preview/IMimeIconProvider.php2
2 files changed, 19 insertions, 5 deletions
diff --git a/lib/public/Preview/BeforePreviewFetchedEvent.php b/lib/public/Preview/BeforePreviewFetchedEvent.php
index ac3c8c13b55..8ab875070d9 100644
--- a/lib/public/Preview/BeforePreviewFetchedEvent.php
+++ b/lib/public/Preview/BeforePreviewFetchedEvent.php
@@ -11,7 +11,13 @@ use OCP\Files\Node;
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.
+ * @since 31.0.0 the constructor arguments ``$mimeType`` was added
*/
class BeforePreviewFetchedEvent extends \OCP\EventDispatcher\Event {
/**
@@ -19,14 +25,15 @@ class BeforePreviewFetchedEvent extends \OCP\EventDispatcher\Event {
*/
public function __construct(
private Node $node,
- /** @deprecated 28.0.0 null deprecated **/
+ /** @deprecated 28.0.0 passing null is deprecated **/
private ?int $width = null,
- /** @deprecated 28.0.0 null deprecated **/
+ /** @deprecated 28.0.0 passing null is deprecated **/
private ?int $height = null,
- /** @deprecated 28.0.0 null deprecated **/
+ /** @deprecated 28.0.0 passing null is deprecated **/
private ?bool $crop = null,
- /** @deprecated 28.0.0 null deprecated **/
+ /** @deprecated 28.0.0 passing null is deprecated **/
private ?string $mode = null,
+ private ?string $mimeType = null,
) {
parent::__construct();
}
@@ -66,4 +73,11 @@ class BeforePreviewFetchedEvent extends \OCP\EventDispatcher\Event {
public function getMode(): ?string {
return $this->mode;
}
+
+ /**
+ * @since 31.0.0
+ */
+ public function getMimeType(): ?string {
+ return $this->mimeType;
+ }
}
diff --git a/lib/public/Preview/IMimeIconProvider.php b/lib/public/Preview/IMimeIconProvider.php
index da4896bec87..4a407f48577 100644
--- a/lib/public/Preview/IMimeIconProvider.php
+++ b/lib/public/Preview/IMimeIconProvider.php
@@ -18,5 +18,5 @@ interface IMimeIconProvider {
* if no preview is available.
* @since 28.0.0
*/
- public function getMimeIconUrl(string $mime): string|null;
+ public function getMimeIconUrl(string $mime): ?string;
}