CloudFederationProviderManager¶
-
class
OC\Federation\
CloudFederationProviderManager
¶ - Class ManagerManage Cloud Federation Providers
Source: lib/private/Federation/CloudFederationProviderManager.php#45 Implements: OCP\Federation\ICloudFederationProviderManager
Properties¶
Methods¶
-
public
OC\Federation\CloudFederationProviderManager::
__construct
($appManager, $httpClientService, $cloudIdManager, $logger)¶ - CloudFederationProviderManager constructor.
Source: lib/private/Federation/CloudFederationProviderManager.php#75
Parameters: - $appManager (
OCP\App\IAppManager
) - $httpClientService (
OCP\Http\Client\IClientService
) - $cloudIdManager (
OCP\Federation\ICloudIdManager
) - $logger (
OCP\ILogger
)
- $appManager (
-
public
OC\Federation\CloudFederationProviderManager::
addCloudFederationProvider
($resourceType, $displayName, $callback)¶ - Registers an callback function which must return an cloud federation provider
Source: lib/private/Federation/CloudFederationProviderManager.php#94
Parameters: - $resourceType (string) which resource type does the provider handles
- $displayName (string) user facing name of the federated share provider
- $callback (callable)
-
public
OC\Federation\CloudFederationProviderManager::
removeCloudFederationProvider
($providerId)¶ - remove cloud federation provider
Source: lib/private/Federation/CloudFederationProviderManager.php#107
Parameters: - $providerId (string)
-
public
OC\Federation\CloudFederationProviderManager::
getAllCloudFederationProviders
()¶ - get a list of all cloudFederationProviders
Source: lib/private/Federation/CloudFederationProviderManager.php#116 Returns: array [resourceType => [‘resourceType’ => $resourceType, ‘displayName’ => $displayName, ‘callback’ => callback]]
-
public
OC\Federation\CloudFederationProviderManager::
getCloudFederationProvider
($resourceType)¶ - get a specific cloud federation provider
Source: lib/private/Federation/CloudFederationProviderManager.php#127
Parameters: - $resourceType (string)
Returns: Throws:
-
public
OC\Federation\CloudFederationProviderManager::
sendNotification
($url, $notification)¶ Source: lib/private/Federation/CloudFederationProviderManager.php#173
Parameters: - $url (string)
- $notification (
OCP\Federation\ICloudFederationNotification
)
Returns: mixed
-
public
OC\Federation\CloudFederationProviderManager::
isReady
()¶ - check if the new cloud federation API is ready to be used
Source: lib/private/Federation/CloudFederationProviderManager.php#205 Returns: bool
-
protected
OC\Federation\CloudFederationProviderManager::
getOCMEndPoint
($url)¶ - check if server supports the new OCM api and ask for the correct end-point
Source: lib/private/Federation/CloudFederationProviderManager.php#214
Parameters: - $url (string) full base URL of the cloud server
Returns: string