IDiscoveryService.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2017 Bjoern Schiessle <bjoern@schiessle.org>
  5. *
  6. * @author Bjoern Schiessle <bjoern@schiessle.org>
  7. * @author Morris Jobke <hey@morrisjobke.de>
  8. * @author Roeland Jago Douma <roeland@famdouma.nl>
  9. *
  10. * @license GNU AGPL version 3 or any later version
  11. *
  12. * This program is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License as
  14. * published by the Free Software Foundation, either version 3 of the
  15. * License, or (at your option) any later version.
  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
  23. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24. *
  25. */
  26. namespace OCP\OCS;
  27. /**
  28. * Interface IDiscoveryService
  29. *
  30. * Allows you to discover OCS end-points on a remote server
  31. *
  32. * @since 12.0.0
  33. */
  34. interface IDiscoveryService {
  35. /**
  36. * Discover OCS end-points
  37. *
  38. * If no valid discovery data is found the defaults are returned
  39. *
  40. * @since 12.0.0
  41. *
  42. * @param string $remote
  43. * @param string $service the service you want to discover
  44. * @param bool $skipCache We won't check if the data is in the cache. This is useful if a background job is updating the status - Added in 14.0.0
  45. * @return array
  46. */
  47. public function discover(string $remote, string $service, bool $skipCache = false): array;
  48. }