aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Collaboration/Reference/IDiscoverableReferenceProvider.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Collaboration/Reference/IDiscoverableReferenceProvider.php')
-rw-r--r--lib/public/Collaboration/Reference/IDiscoverableReferenceProvider.php44
1 files changed, 44 insertions, 0 deletions
diff --git a/lib/public/Collaboration/Reference/IDiscoverableReferenceProvider.php b/lib/public/Collaboration/Reference/IDiscoverableReferenceProvider.php
new file mode 100644
index 00000000000..af4c6b3b1f6
--- /dev/null
+++ b/lib/public/Collaboration/Reference/IDiscoverableReferenceProvider.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Collaboration\Reference;
+
+/**
+ * @since 26.0.0
+ */
+interface IDiscoverableReferenceProvider extends IReferenceProvider {
+ /**
+ * @return string Unique id that identifies the reference provider
+ * @since 26.0.0
+ */
+ public function getId(): string;
+
+ /**
+ * @return string User facing title of the widget
+ * @since 26.0.0
+ */
+ public function getTitle(): string;
+
+ /**
+ * @return int Initial order for reference provider sorting
+ * @since 26.0.0
+ */
+ public function getOrder(): int;
+
+ /**
+ * @return string url to an icon that can be displayed next to the reference provider title
+ * @since 26.0.0
+ */
+ public function getIconUrl(): string;
+
+ /**
+ * @return array representation of the provider
+ * @since 26.0.0
+ */
+ public function jsonSerialize(): array;
+}