API.php 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Bart Visscher <bartv@thisnet.nl>
  6. * @author Joas Schilling <coding@schilljs.com>
  7. * @author Morris Jobke <hey@morrisjobke.de>
  8. * @author Roeland Jago Douma <roeland@famdouma.nl>
  9. * @author Tom Needham <tom@owncloud.com>
  10. *
  11. * @license AGPL-3.0
  12. *
  13. * This code is free software: you can redistribute it and/or modify
  14. * it under the terms of the GNU Affero General Public License, version 3,
  15. * as published by the Free Software Foundation.
  16. *
  17. * This program is distributed in the hope that it will be useful,
  18. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. * GNU Affero General Public License for more details.
  21. *
  22. * You should have received a copy of the GNU Affero General Public License, version 3,
  23. * along with this program. If not, see <http://www.gnu.org/licenses/>
  24. *
  25. */
  26. /**
  27. * Public interface of ownCloud for apps to use.
  28. * API Class
  29. *
  30. */
  31. // use OCP namespace for all classes that are considered public.
  32. // This means that they should be used by apps instead of the internal ownCloud classes
  33. namespace OCP;
  34. /**
  35. * This class provides functions to manage apps in ownCloud
  36. * @since 5.0.0
  37. * @deprecated 9.1.0 Use the AppFramework
  38. */
  39. class API {
  40. /**
  41. * API authentication levels
  42. * @since 8.1.0
  43. */
  44. const GUEST_AUTH = 0;
  45. const USER_AUTH = 1;
  46. const SUBADMIN_AUTH = 2;
  47. const ADMIN_AUTH = 3;
  48. /**
  49. * API Response Codes
  50. * @since 8.1.0
  51. */
  52. const RESPOND_UNAUTHORISED = 997;
  53. const RESPOND_SERVER_ERROR = 996;
  54. const RESPOND_NOT_FOUND = 998;
  55. const RESPOND_UNKNOWN_ERROR = 999;
  56. /**
  57. * registers an api call
  58. * @param string $method the http method
  59. * @param string $url the url to match
  60. * @param callable $action the function to run
  61. * @param string $app the id of the app registering the call
  62. * @param int $authLevel the level of authentication required for the call (See `self::*_AUTH` constants)
  63. * @param array $defaults
  64. * @param array $requirements
  65. * @since 5.0.0
  66. * @deprecated 9.1.0 Use the AppFramework
  67. */
  68. public static function register($method, $url, $action, $app, $authLevel = self::USER_AUTH,
  69. $defaults = array(), $requirements = array()){
  70. \OC_API::register($method, $url, $action, $app, $authLevel, $defaults, $requirements);
  71. }
  72. }