ICloudFederationProviderManager¶
-
interface
OCP\Federation\
ICloudFederationProviderManager
¶ - Class ICloudFederationProviderManagerManage cloud federation providers
Implemented by: OC\Federation\CloudFederationProviderManager
Source: lib/public/Federation/ICloudFederationProviderManager.php#35
Methods¶
-
public
OCP\Federation\ICloudFederationProviderManager::
addCloudFederationProvider
($resourceType, $displayName, $callback)¶ - Registers an callback function which must return an cloud federation provider
Source: lib/public/Federation/ICloudFederationProviderManager.php#47
Parameters: - $resourceType (string) which resource type does the provider handles
- $displayName (string) user facing name of the federated share provider
- $callback (callable)
Throws: Since: 14.0.0
-
public
OCP\Federation\ICloudFederationProviderManager::
removeCloudFederationProvider
($resourceType)¶ - remove cloud federation provider
Source: lib/public/Federation/ICloudFederationProviderManager.php#56
Parameters: - $resourceType (string)
Since: 14.0.0
-
public
OCP\Federation\ICloudFederationProviderManager::
getAllCloudFederationProviders
()¶ - get a list of all cloudFederationProviders
Source: lib/public/Federation/ICloudFederationProviderManager.php#65 Returns: array [resourceType => [‘resourceType’ => $resourceType, ‘displayName’ => $displayName, ‘callback’ => callback]] Since: 14.0.0
-
public
OCP\Federation\ICloudFederationProviderManager::
getCloudFederationProvider
($resourceType)¶ - get a specific cloud federation provider
Source: lib/public/Federation/ICloudFederationProviderManager.php#76
Parameters: - $resourceType (string)
Returns: Throws: Since: 14.0.0
- send federated share
Source: lib/public/Federation/ICloudFederationProviderManager.php#86
Parameters: - $share (
OCP\Federation\ICloudFederationShare
)
Returns: mixed
Since: 14.0.0
- $share (
-
public
OCP\Federation\ICloudFederationProviderManager::
sendNotification
($url, $notification)¶ - send notification about existing share
Source: lib/public/Federation/ICloudFederationProviderManager.php#97
Parameters: - $url (string)
- $notification (
OCP\Federation\ICloudFederationNotification
)
Returns: mixed
Since: 14.0.0
-
public
OCP\Federation\ICloudFederationProviderManager::
isReady
()¶ - check if the new cloud federation API is ready to be used
Source: lib/public/Federation/ICloudFederationProviderManager.php#106 Returns: bool Since: 14.0.0