ICloudFederationShare¶

interface OCP\Federation\ICloudFederationShare¶

Interface ICloudFederationShare

Implemented by:	`OC\Federation\CloudFederationShare`
Source:	lib/public/Federation/ICloudFederationShare.php#32

Methods¶

public OCP\Federation\ICloudFederationShare::setShareWith($user)¶

set uid of the recipient

Source:	lib/public/Federation/ICloudFederationShare.php#41
Parameters:	$user (string)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setResourceName($name)¶

set resource name (e.g. file, calendar, contact,.

..)

Source:	lib/public/Federation/ICloudFederationShare.php#50
Parameters:	$name (string)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setResourceType($resourceType)¶

set resource type (e.g. file, calendar, contact,.

..)

Source:	lib/public/Federation/ICloudFederationShare.php#59
Parameters:	$resourceType (string)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setDescription($description)¶

set resource description (optional)

Source:	lib/public/Federation/ICloudFederationShare.php#68
Parameters:	$description (string)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setProviderId($providerId)¶

set provider ID (e.g. file ID)

Source:	lib/public/Federation/ICloudFederationShare.php#77
Parameters:	$providerId (string)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setOwner($owner)¶

set owner UID

Source:	lib/public/Federation/ICloudFederationShare.php#86
Parameters:	$owner (string)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setOwnerDisplayName($ownerDisplayName)¶

set owner display name

Source:	lib/public/Federation/ICloudFederationShare.php#95
Parameters:	$ownerDisplayName (string)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setSharedBy($sharedBy)¶

set UID of the user who sends the share

Source:	lib/public/Federation/ICloudFederationShare.php#104
Parameters:	$sharedBy (string)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setSharedByDisplayName($sharedByDisplayName)¶

set display name of the user who sends the share

Source:	lib/public/Federation/ICloudFederationShare.php#113
Parameters:	$sharedByDisplayName
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setProtocol($protocol)¶

set protocol specification

Source:	lib/public/Federation/ICloudFederationShare.php#122
Parameters:	$protocol (array)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::setShareType($shareType)¶

share type (group or user)

Source:	lib/public/Federation/ICloudFederationShare.php#131
Parameters:	$shareType (string)
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getShare()¶

get the whole share, ready to send out

Source:	lib/public/Federation/ICloudFederationShare.php#140
Returns:	array
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getShareWith()¶

get uid of the recipient

Source:	lib/public/Federation/ICloudFederationShare.php#149
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getResourceName()¶

get resource name (e.g. file, calendar, contact,.

..)

Source:	lib/public/Federation/ICloudFederationShare.php#158
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getResourceType()¶

get resource type (e.g. file, calendar, contact,.

..)

Source:	lib/public/Federation/ICloudFederationShare.php#167
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getDescription()¶

get resource description (optional)

Source:	lib/public/Federation/ICloudFederationShare.php#176
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getProviderId()¶

get provider ID (e.g. file ID)

Source:	lib/public/Federation/ICloudFederationShare.php#185
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getOwner()¶

get owner UID

Source:	lib/public/Federation/ICloudFederationShare.php#194
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getOwnerDisplayName()¶

get owner display name

Source:	lib/public/Federation/ICloudFederationShare.php#203
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getSharedBy()¶

get UID of the user who sends the share

Source:	lib/public/Federation/ICloudFederationShare.php#212
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getSharedByDisplayName()¶

get display name of the user who sends the share

Source:	lib/public/Federation/ICloudFederationShare.php#221
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getShareType()¶

get share type (group or user)

Source:	lib/public/Federation/ICloudFederationShare.php#230
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getShareSecret()¶

get share Secret

Source:	lib/public/Federation/ICloudFederationShare.php#239
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationShare::getProtocol()¶

get protocol specification

Source:	lib/public/Federation/ICloudFederationShare.php#249
Returns:	array
Since:	14.0.0