1
0

ICloudFederationFactory.php 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
  4. *
  5. * @author Bjoern Schiessle <bjoern@schiessle.org>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\Federation;
  24. /**
  25. * Interface ICloudFederationFactory
  26. *
  27. *
  28. * @since 14.0.0
  29. */
  30. interface ICloudFederationFactory {
  31. /**
  32. * get a CloudFederationShare Object to prepare a share you want to send
  33. *
  34. * @param string $shareWith
  35. * @param string $name resource name (e.g. document.odt)
  36. * @param string $description share description (optional)
  37. * @param string $providerId resource UID on the provider side
  38. * @param string $owner provider specific UID of the user who owns the resource
  39. * @param string $ownerDisplayName display name of the user who shared the item
  40. * @param string $sharedBy provider specific UID of the user who shared the resource
  41. * @param string $sharedByDisplayName display name of the user who shared the resource
  42. * @param string $sharedSecret used to authenticate requests across servers
  43. * @param string $shareType ('group' or 'user' share)
  44. * @param $resourceType ('file', 'calendar',...)
  45. * @return ICloudFederationShare
  46. *
  47. * @since 14.0.0
  48. */
  49. public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType);
  50. /**
  51. * get a Cloud FederationNotification object to prepare a notification you
  52. * want to send
  53. *
  54. * @return ICloudFederationNotification
  55. *
  56. * @since 14.0.0
  57. */
  58. public function getCloudFederationNotification();
  59. }