Nextcloud PHP API (stable18)

ICloudFederationFactory

Interface ICloudFederationFactory

Tags
since
14.0.0

Table of Contents

getCloudFederationNotification()  : ICloudFederationNotification
get a Cloud FederationNotification object to prepare a notification you want to send
getCloudFederationShare()  : ICloudFederationShare
get a CloudFederationShare Object to prepare a share you want to send

Methods

getCloudFederationShare()

get a CloudFederationShare Object to prepare a share you want to send

public getCloudFederationShare(string $shareWith, string $name, string $description, string $providerId, string $owner, string $ownerDisplayName, string $sharedBy, string $sharedByDisplayName, string $sharedSecret, string $shareType,  $resourceType) : ICloudFederationShare
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 :

'calendar',...)

Tags
since
14.0.0
Return values
ICloudFederationShare

Search results