aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Files/Template/ICustomTemplateProvider.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Files/Template/ICustomTemplateProvider.php')
-rw-r--r--lib/public/Files/Template/ICustomTemplateProvider.php33
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/public/Files/Template/ICustomTemplateProvider.php b/lib/public/Files/Template/ICustomTemplateProvider.php
new file mode 100644
index 00000000000..6136bc4f1c0
--- /dev/null
+++ b/lib/public/Files/Template/ICustomTemplateProvider.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Files\Template;
+
+use OCP\Files\File;
+
+/**
+ * @since 21.0.0
+ */
+interface ICustomTemplateProvider {
+ /**
+ * Return a list of additional templates that the template provider is offering
+ *
+ * @return Template[]
+ * @since 21.0.0
+ */
+ public function getCustomTemplates(string $mimetype): array;
+
+ /**
+ * Return the file for a given template id
+ *
+ * @param string $template identifier of the template
+ * @return File
+ * @since 21.0.0
+ */
+ public function getCustomTemplate(string $template): File;
+}