ICloudFederationFactory.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. /**
  3. * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
  4. * SPDX-License-Identifier: AGPL-3.0-or-later
  5. */
  6. namespace OCP\Federation;
  7. /**
  8. * Interface ICloudFederationFactory
  9. *
  10. *
  11. * @since 14.0.0
  12. */
  13. interface ICloudFederationFactory {
  14. /**
  15. * get a CloudFederationShare Object to prepare a share you want to send
  16. *
  17. * @param string $shareWith
  18. * @param string $name resource name (e.g. document.odt)
  19. * @param string $description share description (optional)
  20. * @param string $providerId resource UID on the provider side
  21. * @param string $owner provider specific UID of the user who owns the resource
  22. * @param string $ownerDisplayName display name of the user who shared the item
  23. * @param string $sharedBy provider specific UID of the user who shared the resource
  24. * @param string $sharedByDisplayName display name of the user who shared the resource
  25. * @param string $sharedSecret used to authenticate requests across servers
  26. * @param string $shareType ('group' or 'user' share)
  27. * @param $resourceType ('file', 'calendar',...)
  28. * @return ICloudFederationShare
  29. *
  30. * @since 14.0.0
  31. */
  32. public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType);
  33. /**
  34. * get a Cloud FederationNotification object to prepare a notification you
  35. * want to send
  36. *
  37. * @return ICloudFederationNotification
  38. *
  39. * @since 14.0.0
  40. */
  41. public function getCloudFederationNotification();
  42. }