aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Dashboard/IConditionalWidget.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Dashboard/IConditionalWidget.php')
-rw-r--r--lib/public/Dashboard/IConditionalWidget.php26
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/public/Dashboard/IConditionalWidget.php b/lib/public/Dashboard/IConditionalWidget.php
new file mode 100644
index 00000000000..5c1445bbca8
--- /dev/null
+++ b/lib/public/Dashboard/IConditionalWidget.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Dashboard;
+
+/**
+ * interface IConditionalWidget
+ *
+ * Allows an app to lazy-register a widget and in the lazy part of the code
+ * it can decide if the widget should really be registered.
+ *
+ * @since 26.0.0
+ */
+interface IConditionalWidget extends IWidget {
+ /**
+ * @return bool Whether the widget is enabled and should be registered
+ * @since 26.0.0
+ */
+ public function isEnabled(): bool;
+}