aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/TaskProcessing/ITaskType.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/TaskProcessing/ITaskType.php')
-rw-r--r--lib/public/TaskProcessing/ITaskType.php57
1 files changed, 57 insertions, 0 deletions
diff --git a/lib/public/TaskProcessing/ITaskType.php b/lib/public/TaskProcessing/ITaskType.php
new file mode 100644
index 00000000000..c562861f91d
--- /dev/null
+++ b/lib/public/TaskProcessing/ITaskType.php
@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\TaskProcessing;
+
+/**
+ * This is a task type interface that is implemented by task processing
+ * task types
+ * @since 30.0.0
+ */
+interface ITaskType {
+ /**
+ * Returns the unique id of this task type
+ *
+ * @since 30.0.0
+ * @return string
+ */
+ public function getId(): string;
+
+ /**
+ * Returns the localized name of this task type
+ *
+ * @since 30.0.0
+ * @return string
+ */
+ public function getName(): string;
+
+ /**
+ * Returns the localized description of this task type
+ *
+ * @since 30.0.0
+ * @return string
+ */
+ public function getDescription(): string;
+
+ /**
+ * Returns the shape of the input array
+ *
+ * @since 30.0.0
+ * @psalm-return ShapeDescriptor[]
+ */
+ public function getInputShape(): array;
+
+ /**
+ * Returns the shape of the output array
+ *
+ * @since 30.0.0
+ * @psalm-return ShapeDescriptor[]
+ */
+ public function getOutputShape(): array;
+}