aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Files/SimpleFS/ISimpleRoot.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Files/SimpleFS/ISimpleRoot.php')
-rw-r--r--lib/public/Files/SimpleFS/ISimpleRoot.php45
1 files changed, 45 insertions, 0 deletions
diff --git a/lib/public/Files/SimpleFS/ISimpleRoot.php b/lib/public/Files/SimpleFS/ISimpleRoot.php
new file mode 100644
index 00000000000..6be8a1d47c9
--- /dev/null
+++ b/lib/public/Files/SimpleFS/ISimpleRoot.php
@@ -0,0 +1,45 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Files\SimpleFS;
+
+use OCP\Files\NotFoundException;
+use OCP\Files\NotPermittedException;
+
+/**
+ * Interface ISimpleRoot
+ *
+ * @since 11.0.0
+ */
+interface ISimpleRoot {
+ /**
+ * Get the folder with name $name
+ *
+ * @throws NotFoundException
+ * @throws \RuntimeException
+ * @since 11.0.0
+ */
+ public function getFolder(string $name): ISimpleFolder;
+
+ /**
+ * Get all the Folders
+ *
+ * @return ISimpleFolder[]
+ * @throws NotFoundException
+ * @throws \RuntimeException
+ * @since 11.0.0
+ */
+ public function getDirectoryListing(): array;
+
+ /**
+ * Create a new folder named $name
+ *
+ * @throws NotPermittedException
+ * @throws \RuntimeException
+ * @since 11.0.0
+ */
+ public function newFolder(string $name): ISimpleFolder;
+}