CloudFederationShare

class OC\Federation\CloudFederationShare
Source:lib/private/Federation/CloudFederationShare.php#30
Implements:OCP\Federation\ICloudFederationShare

Properties

Methods

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

lib/private/Federation/CloudFederationShare.php#60

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
  • $shareType (string) (‘group’ or ‘user’ share)
  • $resourceType (string) (‘file’, ‘calendar’,...)
  • $sharedSecret (string)
public OC\Federation\CloudFederationShare::setShareWith($user)
set uid of the recipient
Source:

lib/private/Federation/CloudFederationShare.php#98

Parameters:
  • $user (string)
Since:

14.0.0

public OC\Federation\CloudFederationShare::setResourceName($name)
set resource name (e.g. document.odt)
Source:

lib/private/Federation/CloudFederationShare.php#109

Parameters:
  • $name (string)
Since:

14.0.0

public OC\Federation\CloudFederationShare::setResourceType($resourceType)
set resource type (e.g. file, calendar, contact,.
..)
Source:

lib/private/Federation/CloudFederationShare.php#120

Parameters:
  • $resourceType (string)
Since:

14.0.0

public OC\Federation\CloudFederationShare::setDescription($description)
set resource description (optional)
Source:

lib/private/Federation/CloudFederationShare.php#131

Parameters:
  • $description (string)
Since:

14.0.0

public OC\Federation\CloudFederationShare::setProviderId($providerId)
set provider ID (e.g. file ID)
Source:

lib/private/Federation/CloudFederationShare.php#142

Parameters:
  • $providerId (string)
Since:

14.0.0

public OC\Federation\CloudFederationShare::setOwner($owner)
set owner UID
Source:

lib/private/Federation/CloudFederationShare.php#153

Parameters:
  • $owner (string)
Since:

14.0.0

public OC\Federation\CloudFederationShare::setOwnerDisplayName($ownerDisplayName)
set owner display name
Source:

lib/private/Federation/CloudFederationShare.php#164

Parameters:
  • $ownerDisplayName (string)
Since:

14.0.0

public OC\Federation\CloudFederationShare::setSharedBy($sharedBy)
set UID of the user who sends the share
Source:

lib/private/Federation/CloudFederationShare.php#175

Parameters:
  • $sharedBy (string)
Since:

14.0.0

public OC\Federation\CloudFederationShare::setSharedByDisplayName($sharedByDisplayName)
set display name of the user who sends the share
Source:

lib/private/Federation/CloudFederationShare.php#186

Parameters:
  • $sharedByDisplayName
Since:

14.0.0

public OC\Federation\CloudFederationShare::setProtocol($protocol)
set protocol specification
Source:

lib/private/Federation/CloudFederationShare.php#197

Parameters:
  • $protocol (array)
Since:

14.0.0

public OC\Federation\CloudFederationShare::setShareType($shareType)
share type (group or user)
Source:

lib/private/Federation/CloudFederationShare.php#208

Parameters:
  • $shareType (string)
Since:

14.0.0

public OC\Federation\CloudFederationShare::getShare()
get the whole share, ready to send out
Source:lib/private/Federation/CloudFederationShare.php#223
Returns:array
Since:14.0.0
public OC\Federation\CloudFederationShare::getShareWith()
get uid of the recipient
Source:lib/private/Federation/CloudFederationShare.php#234
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getResourceName()
get resource name (e.g. file, calendar, contact,.
..)
Source:lib/private/Federation/CloudFederationShare.php#245
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getResourceType()
get resource type (e.g. file, calendar, contact,.
..)
Source:lib/private/Federation/CloudFederationShare.php#256
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getDescription()
get resource description (optional)
Source:lib/private/Federation/CloudFederationShare.php#267
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getProviderId()
get provider ID (e.g. file ID)
Source:lib/private/Federation/CloudFederationShare.php#278
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getOwner()
get owner UID
Source:lib/private/Federation/CloudFederationShare.php#289
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getOwnerDisplayName()
get owner display name
Source:lib/private/Federation/CloudFederationShare.php#300
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getSharedBy()
get UID of the user who sends the share
Source:lib/private/Federation/CloudFederationShare.php#311
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getSharedByDisplayName()
get display name of the user who sends the share
Source:lib/private/Federation/CloudFederationShare.php#322
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getShareType()
get share type (group or user)
Source:lib/private/Federation/CloudFederationShare.php#333
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getShareSecret()
get share Secret
Source:lib/private/Federation/CloudFederationShare.php#344
Returns:string
Since:14.0.0
public OC\Federation\CloudFederationShare::getProtocol()
get protocol specification
Source:lib/private/Federation/CloudFederationShare.php#355
Returns:array
Since:14.0.0