ICloudFederationProvider¶

interface OCP\Federation\ICloudFederationProvider¶

Interface ICloudFederationProvider

Enable apps to create their own cloud federation provider

Source:	lib/public/Federation/ICloudFederationProvider.php#42

Methods¶

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

get the name of the share type, handled by this provider

Source:	lib/public/Federation/ICloudFederationProvider.php#51
Returns:	string
Since:	14.0.0

public OCP\Federation\ICloudFederationProvider::shareReceived($share)¶

share received from another server

Source:	lib/public/Federation/ICloudFederationProvider.php#63
Parameters:	$share (`OCP\Federation\ICloudFederationShare`)
Returns:	string provider specific unique ID of the share
Throws:	`\OCP\Federation\Exceptions\ProviderCouldNotAddShareException`
Since:	14.0.0

public OCP\Federation\ICloudFederationProvider::notificationReceived($notificationType, $providerId, $notification)¶

notification received from another server

Source:	lib/public/Federation/ICloudFederationProvider.php#80
Parameters:	$notificationType (string) (e.g SHARE_ACCEPTED) $providerId (string) share ID $notification (array) provider specific notification
Returns:	array $data send back to sender
Throws:	`\OCP\Share\Exceptions\ShareNotFound`
Throws:	`\OCP\Federation\Exceptions\ActionNotSupportedException`
Throws:	`\OCP\Federation\Exceptions\BadRequestException`
Throws:	`\OCP\Federation\Exceptions\AuthenticationFailedException`
Throws:	`\OCP\Share\Exceptions\ShareNotFound`
Throws:	`\OCP\Federation\Exceptions\ActionNotSupportedException`
Throws:	`\OCP\Federation\Exceptions\BadRequestException`
Throws:	`\OCP\Federation\Exceptions\AuthenticationFailedException`
Throws:	`\OCP\Share\Exceptions\ShareNotFound`
Throws:	`\OCP\Federation\Exceptions\ActionNotSupportedException`
Throws:	`\OCP\Federation\Exceptions\BadRequestException`
Throws:	`\OCP\Federation\Exceptions\AuthenticationFailedException`
Throws:	`\OCP\Share\Exceptions\ShareNotFound`
Throws:	`\OCP\Federation\Exceptions\ActionNotSupportedException`
Throws:	`\OCP\Federation\Exceptions\BadRequestException`
Throws:	`\OCP\Federation\Exceptions\AuthenticationFailedException`
Since:	14.0.0

public OCP\Federation\ICloudFederationProvider::getSupportedShareTypes()¶

get the supported share types, e.g. “user”, “group”, etc.

Source:	lib/public/Federation/ICloudFederationProvider.php#89
Returns:	array
Since:	14.0.0