aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/TextProcessing/IProviderWithUserId.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/TextProcessing/IProviderWithUserId.php')
-rw-r--r--lib/public/TextProcessing/IProviderWithUserId.php26
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/public/TextProcessing/IProviderWithUserId.php b/lib/public/TextProcessing/IProviderWithUserId.php
new file mode 100644
index 00000000000..197dd3d9740
--- /dev/null
+++ b/lib/public/TextProcessing/IProviderWithUserId.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+
+namespace OCP\TextProcessing;
+
+/**
+ * This interface allows providers to access the user that initiated the task being run.
+ * @since 28.0.0
+ * @template T of ITaskType
+ * @template-extends IProvider<T>
+ * @deprecated 30.0.0
+ */
+interface IProviderWithUserId extends IProvider {
+ /**
+ * @param ?string $userId the current user's id
+ * @since 28.0.0
+ */
+ public function setUserId(?string $userId): void;
+}