ICloudFederationFactory

interface OCP\Federation\ICloudFederationFactory
Interface ICloudFederationFactory
Implemented by:OC\Federation\CloudFederationFactory
Source:lib/public/Federation/ICloudFederationFactory.php#32

Methods

public OCP\Federation\ICloudFederationFactory::getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType)
get a CloudFederationShare Object to prepare a share you want to send
Source:

lib/public/Federation/ICloudFederationFactory.php#52
Parameters:
  • $shareWith (string)
  • $name (string) resource name (e.g. document.odt)
  • $description (string) share description (optional)
  • $providerId (string) resource UID on the provider side
  • $owner (string) provider specific UID of the user who owns the resource
  • $ownerDisplayName (string) display name of the user who shared the item
  • $sharedBy (string) provider specific UID of the user who shared the resource
  • $sharedByDisplayName (string) display name of the user who shared the resource
  • $sharedSecret (string) used to authenticate requests across servers
  • $shareType (string) (‘group’ or ‘user’ share)
  • $resourceType (‘file’, ‘calendar’,...)
Returns:

\OCP\Federation\ICloudFederationShare
Since:

14.0.0
public OCP\Federation\ICloudFederationFactory::getCloudFederationNotification()
get a Cloud FederationNotification object to prepare a notification you
want to send
Source:lib/public/Federation/ICloudFederationFactory.php#62
Returns:\OCP\Federation\ICloudFederationNotification
Since:14.0.0