aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_trashbin/lib/Controller/PreviewController.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_trashbin/lib/Controller/PreviewController.php')
-rw-r--r--apps/files_trashbin/lib/Controller/PreviewController.php13
1 files changed, 12 insertions, 1 deletions
diff --git a/apps/files_trashbin/lib/Controller/PreviewController.php b/apps/files_trashbin/lib/Controller/PreviewController.php
index 9f60cc8b0b2..e62a793a98f 100644
--- a/apps/files_trashbin/lib/Controller/PreviewController.php
+++ b/apps/files_trashbin/lib/Controller/PreviewController.php
@@ -85,7 +85,18 @@ class PreviewController extends Controller {
* @NoAdminRequired
* @NoCSRFRequired
*
- * @return DataResponse|Http\FileDisplayResponse
+ * Get the preview for a file
+ *
+ * @param int $fileId ID of the file
+ * @param int $x Width of the preview
+ * @param int $y Height of the preview
+ * @param bool $a Whether to not crop the preview
+ *
+ * @return Http\FileDisplayResponse<Http::STATUS_OK, array{Content-Type: string}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND, array<empty>, array{}>
+ *
+ * 200: Preview returned
+ * 400: Getting preview is not possible
+ * 404: Preview not found
*/
public function getPreview(
int $fileId = -1,