ICloudId.php 1.5 KB

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