1 files changed, 83 insertions, 0 deletions
diff --git a/lib/public/Preview/BeforePreviewFetchedEvent.php b/lib/public/Preview/BeforePreviewFetchedEvent.php
new file mode 100644
index 00000000000..8ab875070d9
--- /dev/null
+++ b/lib/public/Preview/BeforePreviewFetchedEvent.php
@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Preview;
+
+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 {
+	/**
+	 * @since 25.0.1
+	 */
+	public function __construct(
+		private Node $node,
+		/** @deprecated 28.0.0 passing null is deprecated **/
+		private ?int $width = null,
+		/** @deprecated 28.0.0 passing null is deprecated **/
+		private ?int $height = null,
+		/** @deprecated 28.0.0 passing null is deprecated **/
+		private ?bool $crop = null,
+		/** @deprecated 28.0.0 passing null is deprecated **/
+		private ?string $mode = null,
+		private ?string $mimeType = null,
+	) {
+		parent::__construct();
+	}
+
+	/**
+	 * @since 25.0.1
+	 */
+	public function getNode(): Node {
+		return $this->node;
+	}
+
+	/**
+	 * @since 28.0.0
+	 */
+	public function getWidth(): ?int {
+		return $this->width;
+	}
+
+	/**
+	 * @since 28.0.0
+	 */
+	public function getHeight(): ?int {
+		return $this->height;
+	}
+
+	/**
+	 * @since 28.0.0
+	 */
+	public function isCrop(): ?bool {
+		return $this->crop;
+	}
+
+	/**
+	 * @since 28.0.0
+	 * @return null|IPreview::MODE_FILL|IPreview::MODE_COVER
+	 */
+	public function getMode(): ?string {
+		return $this->mode;
+	}
+
+	/**
+	 * @since 31.0.0
+	 */
+	public function getMimeType(): ?string {
+		return $this->mimeType;
+	}
+}