ICloudFederationShare
Interface ICloudFederationShare
Tags
Table of Contents
- getDescription() : string
- get resource description (optional)
- getOwner() : string
- get owner UID
- getOwnerDisplayName() : string
- get owner display name
- getProtocol() : array
- get protocol specification
- getProviderId() : string
- get provider ID (e.g. file ID)
- getResourceName() : string
- get resource name (e.g. file, calendar, contact,...)
- getResourceType() : string
- get resource type (e.g. file, calendar, contact,...)
- getShare() : array
- get the whole share, ready to send out
- getSharedBy() : string
- get UID of the user who sends the share
- getSharedByDisplayName() : string
- get display name of the user who sends the share
- getShareSecret() : string
- get share Secret
- getShareType() : string
- get share type (group or user)
- getShareWith() : string
- get uid of the recipient
- setDescription() : mixed
- set resource description (optional)
- setOwner() : mixed
- set owner UID
- setOwnerDisplayName() : mixed
- set owner display name
- setProtocol() : mixed
- set protocol specification
- setProviderId() : mixed
- set provider ID (e.g. file ID)
- setResourceName() : mixed
- set resource name (e.g. file, calendar, contact,...)
- setResourceType() : mixed
- set resource type (e.g. file, calendar, contact,...)
- setSharedBy() : mixed
- set UID of the user who sends the share
- setSharedByDisplayName() : mixed
- set display name of the user who sends the share
- setShareType() : mixed
- share type (group or user)
- setShareWith() : mixed
- set uid of the recipient
Methods
getDescription()
get resource description (optional)
public
getDescription() : string
Tags
Return values
string —getOwner()
get owner UID
public
getOwner() : string
Tags
Return values
string —getOwnerDisplayName()
get owner display name
public
getOwnerDisplayName() : string
Tags
Return values
string —getProtocol()
get protocol specification
public
getProtocol() : array
Tags
Return values
array —getProviderId()
get provider ID (e.g. file ID)
public
getProviderId() : string
Tags
Return values
string —getResourceName()
get resource name (e.g. file, calendar, contact,...)
public
getResourceName() : string
Tags
Return values
string —getResourceType()
get resource type (e.g. file, calendar, contact,...)
public
getResourceType() : string
Tags
Return values
string —getShare()
get the whole share, ready to send out
public
getShare() : array
Tags
Return values
array —getSharedBy()
get UID of the user who sends the share
public
getSharedBy() : string
Tags
Return values
string —getSharedByDisplayName()
get display name of the user who sends the share
public
getSharedByDisplayName() : string
Tags
Return values
string —getShareSecret()
get share Secret
public
getShareSecret() : string
Tags
Return values
string —getShareType()
get share type (group or user)
public
getShareType() : string
Tags
Return values
string —getShareWith()
get uid of the recipient
public
getShareWith() : string
Tags
Return values
string —setDescription()
set resource description (optional)
public
setDescription(string $description) : mixed
Parameters
- $description : string
Tags
Return values
mixed —setOwner()
set owner UID
public
setOwner(string $owner) : mixed
Parameters
- $owner : string
Tags
Return values
mixed —setOwnerDisplayName()
set owner display name
public
setOwnerDisplayName(string $ownerDisplayName) : mixed
Parameters
- $ownerDisplayName : string
Tags
Return values
mixed —setProtocol()
set protocol specification
public
setProtocol(array $protocol) : mixed
Parameters
- $protocol : array
Tags
Return values
mixed —setProviderId()
set provider ID (e.g. file ID)
public
setProviderId(string $providerId) : mixed
Parameters
- $providerId : string
Tags
Return values
mixed —setResourceName()
set resource name (e.g. file, calendar, contact,...)
public
setResourceName(string $name) : mixed
Parameters
- $name : string
Tags
Return values
mixed —setResourceType()
set resource type (e.g. file, calendar, contact,...)
public
setResourceType(string $resourceType) : mixed
Parameters
- $resourceType : string
Tags
Return values
mixed —setSharedBy()
set UID of the user who sends the share
public
setSharedBy(string $sharedBy) : mixed
Parameters
- $sharedBy : string
Tags
Return values
mixed —setSharedByDisplayName()
set display name of the user who sends the share
public
setSharedByDisplayName( $sharedByDisplayName) : mixed
Parameters
Tags
Return values
mixed —setShareType()
share type (group or user)
public
setShareType(string $shareType) : mixed
Parameters
- $shareType : string
Tags
Return values
mixed —setShareWith()
set uid of the recipient
public
setShareWith(string $user) : mixed
Parameters
- $user : string