aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/IRequestId.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/IRequestId.php')
-rw-r--r--lib/public/IRequestId.php22
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/public/IRequestId.php b/lib/public/IRequestId.php
new file mode 100644
index 00000000000..7c5a5771610
--- /dev/null
+++ b/lib/public/IRequestId.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OCP;
+
+/**
+ * @since 24.0.0
+ */
+interface IRequestId {
+ /**
+ * Returns an ID for the request, value is not guaranteed to be unique and is mostly meant for logging
+ * If `mod_unique_id` is installed this value will be taken.
+ *
+ * @return string
+ * @since 24.0.0
+ */
+ public function getId(): string;
+}