aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_external/lib/Lib/IFrontendDefinition.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_external/lib/Lib/IFrontendDefinition.php')
-rw-r--r--apps/files_external/lib/Lib/IFrontendDefinition.php43
1 files changed, 43 insertions, 0 deletions
diff --git a/apps/files_external/lib/Lib/IFrontendDefinition.php b/apps/files_external/lib/Lib/IFrontendDefinition.php
new file mode 100644
index 00000000000..c8b06a1c30b
--- /dev/null
+++ b/apps/files_external/lib/Lib/IFrontendDefinition.php
@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Files_External\Lib;
+
+interface IFrontendDefinition {
+
+ public function getText(): string;
+
+ public function setText(string $text): self;
+
+ /**
+ * @return array<string, DefinitionParameter>
+ */
+ public function getParameters(): array;
+
+ /**
+ * @param list<DefinitionParameter> $parameters
+ */
+ public function addParameters(array $parameters): self;
+
+ public function addParameter(DefinitionParameter $parameter): self;
+
+ /**
+ * @return string[]
+ */
+ public function getCustomJs(): array;
+
+ public function addCustomJs(string $custom): self;
+
+ /**
+ * Serialize into JSON for client-side JS
+ */
+ public function jsonSerializeDefinition(): array;
+
+ /**
+ * Check if parameters are satisfied in a StorageConfig
+ */
+ public function validateStorageDefinition(StorageConfig $storage): bool;
+}