ICloudId.php 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2017, Robin Appelman <robin@icewind.nl>
  5. *
  6. * @author Robin Appelman <robin@icewind.nl>
  7. * @author Roeland Jago Douma <roeland@famdouma.nl>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\Federation;
  26. /**
  27. * Parsed federated cloud id
  28. *
  29. * @since 12.0.0
  30. */
  31. interface ICloudId {
  32. /**
  33. * The remote cloud id
  34. *
  35. * @return string
  36. * @since 12.0.0
  37. */
  38. public function getId(): string;
  39. /**
  40. * Get a clean representation of the cloud id for display
  41. *
  42. * @return string
  43. * @since 12.0.0
  44. */
  45. public function getDisplayId(): string;
  46. /**
  47. * The username on the remote server
  48. *
  49. * @return string
  50. * @since 12.0.0
  51. */
  52. public function getUser(): string;
  53. /**
  54. * The base address of the remote server
  55. *
  56. * @return string
  57. * @since 12.0.0
  58. */
  59. public function getRemote(): string;
  60. }