Nextcloud PHP API (stable19)

ICloudFederationProvider

Interface ICloudFederationProvider

Enable apps to create their own cloud federation provider

Tags
since
14.0.0

Table of Contents

getShareType()  : string
get the name of the share type, handled by this provider
getSupportedShareTypes()  : array
get the supported share types, e.g. "user", "group", etc.
notificationReceived()  : array
notification received from another server
shareReceived()  : string
share received from another server

Methods

getShareType()

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

public getShareType() : string
Tags
since
14.0.0
Return values
string

getSupportedShareTypes()

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

public getSupportedShareTypes() : array
Tags
since
14.0.0
Return values
array

notificationReceived()

notification received from another server

public notificationReceived(string $notificationType, string $providerId, array $notification) : array
Parameters
$notificationType : string

(e.g SHARE_ACCEPTED)

$providerId : string

share ID

$notification : array

provider specific notification

Tags
throws
ShareNotFound
throws
ActionNotSupportedException
throws
BadRequestException
throws
AuthenticationFailedException
since
14.0.0
Return values
array

$data send back to sender

Search results