adds a trigger hint for complex operations

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

1 files changed, 15 insertions, 2 deletions

diff --git a/lib/public/WorkflowEngine/IComplexOperation.php b/lib/public/WorkflowEngine/IComplexOperation.php
index f3ba6d014a4..63a4ca2460a 100644
--- a/lib/public/WorkflowEngine/IComplexOperation.php
+++ b/lib/public/WorkflowEngine/IComplexOperation.php
@@ -38,6 +38,19 @@ namespace OCP\WorkflowEngine;
  *
  * @package OCP\WorkflowEngine
  *
- * @sincee 18.0.0
+ * @since 18.0.0
  */
-interface IComplexOperation extends IOperation { }
+interface IComplexOperation extends IOperation {
+
+	/**
+	 * As IComplexOperation chooses the triggering events itself, a hint has
+	 * to be shown to the user so make clear when this operation is becoming
+	 * active. This method returns such a translated string.
+	 *
+	 * Example: "When a file is accessed" (en)
+	 *
+	 * @since 18.0.0
+	 */
+	public function getTriggerHint(): string;
+
+}