Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/server.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-05-19 09:00:09 +0300
committerRoeland Jago Douma <rullzer@owncloud.com>2016-05-19 10:43:33 +0300
commitd666725fa783c21235eec79fa6dbe8ba1881fec3 (patch)
tree98914481ca4218c9af2c04db17c6d8f281b0094d /lib/public/API.php
parent4a94203492e3b475ee26b65d5992796152c645bd (diff)
Move \OCP to PSR-4
Diffstat (limited to 'lib/public/API.php')
-rw-r--r--lib/public/API.php75
1 files changed, 75 insertions, 0 deletions
diff --git a/lib/public/API.php b/lib/public/API.php
new file mode 100644
index 00000000000..4d68bef6f29
--- /dev/null
+++ b/lib/public/API.php
@@ -0,0 +1,75 @@
+<?php
+/**
+ * @author Bart Visscher <bartv@thisnet.nl>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Tom Needham <tom@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+/**
+ * Public interface of ownCloud for apps to use.
+ * API Class
+ *
+ */
+
+// use OCP namespace for all classes that are considered public.
+// This means that they should be used by apps instead of the internal ownCloud classes
+namespace OCP;
+
+/**
+ * This class provides functions to manage apps in ownCloud
+ * @since 5.0.0
+ */
+class API {
+
+ /**
+ * API authentication levels
+ * @since 8.1.0
+ */
+ const GUEST_AUTH = 0;
+ const USER_AUTH = 1;
+ const SUBADMIN_AUTH = 2;
+ const ADMIN_AUTH = 3;
+
+ /**
+ * API Response Codes
+ * @since 8.1.0
+ */
+ const RESPOND_UNAUTHORISED = 997;
+ const RESPOND_SERVER_ERROR = 996;
+ const RESPOND_NOT_FOUND = 998;
+ const RESPOND_UNKNOWN_ERROR = 999;
+
+ /**
+ * registers an api call
+ * @param string $method the http method
+ * @param string $url the url to match
+ * @param callable $action the function to run
+ * @param string $app the id of the app registering the call
+ * @param int $authLevel the level of authentication required for the call (See `self::*_AUTH` constants)
+ * @param array $defaults
+ * @param array $requirements
+ * @since 5.0.0
+ */
+ public static function register($method, $url, $action, $app, $authLevel = self::USER_AUTH,
+ $defaults = array(), $requirements = array()){
+ \OC_API::register($method, $url, $action, $app, $authLevel, $defaults, $requirements);
+ }
+
+}